@girs/cdesktopenums-3.0 3.0.0-4.0.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +86 -0
- package/cdesktopenums-3.0-ambient.d.ts +12 -0
- package/cdesktopenums-3.0-ambient.js +2 -0
- package/cdesktopenums-3.0-import.d.ts +12 -0
- package/cdesktopenums-3.0-import.js +3 -0
- package/cdesktopenums-3.0.d.ts +225 -0
- package/cdesktopenums-3.0.js +6 -0
- package/package.json +53 -0
- package/tsconfig.json +23 -0
- package/typedoc.json +7 -0
package/README.md
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
|
|
2
|
+
# CDesktopEnums-3.0
|
|
3
|
+
|
|
4
|
+

|
|
5
|
+

|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
GJS TypeScript type definitions for CDesktopEnums-3.0, generated from library version 3.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.3.
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
To use this type definitions, install them with NPM:
|
|
14
|
+
```bash
|
|
15
|
+
npm install @girs/cdesktopenums-3.0
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
You can import this package into your project like this:
|
|
21
|
+
```ts
|
|
22
|
+
import CDesktopEnums from '@girs/cdesktopenums-3.0';
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Ambient Modules
|
|
26
|
+
|
|
27
|
+
You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
|
|
28
|
+
For this you need to include `@girs/cdesktopenums-3.0` or `@girs/cdesktopenums-3.0/ambient` in your `tsconfig` or entry point Typescript file:
|
|
29
|
+
|
|
30
|
+
`index.ts`:
|
|
31
|
+
```ts
|
|
32
|
+
import '@girs/cdesktopenums-3.0'
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
`tsconfig.json`:
|
|
36
|
+
```json
|
|
37
|
+
{
|
|
38
|
+
"compilerOptions": {
|
|
39
|
+
...
|
|
40
|
+
},
|
|
41
|
+
"include": ["@girs/cdesktopenums-3.0"],
|
|
42
|
+
...
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Now you can import the ambient module with TypeScript support:
|
|
47
|
+
|
|
48
|
+
```ts
|
|
49
|
+
import CDesktopEnums from 'gi://CDesktopEnums?version=3.0';
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Global import
|
|
53
|
+
|
|
54
|
+
You can also import the module with Typescript support using the global `imports.gi` object of GJS.
|
|
55
|
+
For this you need to include `@girs/cdesktopenums-3.0` or `@girs/cdesktopenums-3.0/import` in your `tsconfig` or entry point Typescript file:
|
|
56
|
+
|
|
57
|
+
`index.ts`:
|
|
58
|
+
```ts
|
|
59
|
+
import '@girs/cdesktopenums-3.0'
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
`tsconfig.json`:
|
|
63
|
+
```json
|
|
64
|
+
{
|
|
65
|
+
"compilerOptions": {
|
|
66
|
+
...
|
|
67
|
+
},
|
|
68
|
+
"include": ["@girs/cdesktopenums-3.0"],
|
|
69
|
+
...
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Now you have also type support for this, too:
|
|
74
|
+
|
|
75
|
+
```ts
|
|
76
|
+
const CDesktopEnums = imports.gi.CDesktopEnums;
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Bundle
|
|
80
|
+
|
|
81
|
+
Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
|
|
82
|
+
|
|
83
|
+
## Other packages
|
|
84
|
+
|
|
85
|
+
All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
|
|
86
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
|
|
2
|
+
declare module 'gi://CDesktopEnums?version=3.0' {
|
|
3
|
+
import CDesktopEnums from '@girs/cdesktopenums-3.0';
|
|
4
|
+
export default CDesktopEnums;
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
declare module 'gi://CDesktopEnums' {
|
|
8
|
+
import CDesktopEnums30 from 'gi://CDesktopEnums?version=3.0';
|
|
9
|
+
export default CDesktopEnums30;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Type Definitions for Gjs (https://gjs.guide/)
|
|
3
|
+
*
|
|
4
|
+
* These type definitions are automatically generated, do not edit them by hand.
|
|
5
|
+
* If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import './cdesktopenums-3.0-ambient.d.ts';
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* CDesktopEnums-3.0
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
import type GObject from '@girs/gobject-2.0';
|
|
15
|
+
|
|
16
|
+
export namespace CDesktopEnums {
|
|
17
|
+
enum BackgroundShading {
|
|
18
|
+
SOLID,
|
|
19
|
+
VERTICAL,
|
|
20
|
+
HORIZONTAL,
|
|
21
|
+
}
|
|
22
|
+
enum BackgroundStyle {
|
|
23
|
+
NONE,
|
|
24
|
+
WALLPAPER,
|
|
25
|
+
CENTERED,
|
|
26
|
+
SCALED,
|
|
27
|
+
STRETCHED,
|
|
28
|
+
ZOOM,
|
|
29
|
+
SPANNED,
|
|
30
|
+
}
|
|
31
|
+
enum DeviceSendEvents {
|
|
32
|
+
ENABLED,
|
|
33
|
+
DISABLED,
|
|
34
|
+
DISABLED_ON_EXTERNAL_MOUSE,
|
|
35
|
+
}
|
|
36
|
+
enum FocusMode {
|
|
37
|
+
CLICK,
|
|
38
|
+
SLOPPY,
|
|
39
|
+
MOUSE,
|
|
40
|
+
}
|
|
41
|
+
enum FocusNewWindows {
|
|
42
|
+
SMART,
|
|
43
|
+
STRICT,
|
|
44
|
+
}
|
|
45
|
+
enum MagnifierLensShape {
|
|
46
|
+
NONE,
|
|
47
|
+
SQUARE,
|
|
48
|
+
HORIZONTAL,
|
|
49
|
+
VERTICAL,
|
|
50
|
+
}
|
|
51
|
+
enum MagnifierMouseTrackingMode {
|
|
52
|
+
NONE,
|
|
53
|
+
CENTERED,
|
|
54
|
+
PROPORTIONAL,
|
|
55
|
+
PUSH,
|
|
56
|
+
}
|
|
57
|
+
enum MagnifierScreenPosition {
|
|
58
|
+
NONE,
|
|
59
|
+
FULL_SCREEN,
|
|
60
|
+
TOP_HALF,
|
|
61
|
+
BOTTOM_HALF,
|
|
62
|
+
LEFT_HALF,
|
|
63
|
+
RIGHT_HALF,
|
|
64
|
+
}
|
|
65
|
+
enum MediaKeyType {
|
|
66
|
+
MUTE,
|
|
67
|
+
MUTE_QUIET,
|
|
68
|
+
VOLUME_UP,
|
|
69
|
+
VOLUME_UP_QUIET,
|
|
70
|
+
VOLUME_DOWN,
|
|
71
|
+
VOLUME_DOWN_QUIET,
|
|
72
|
+
MIC_MUTE,
|
|
73
|
+
EJECT,
|
|
74
|
+
MEDIA,
|
|
75
|
+
PLAY,
|
|
76
|
+
PAUSE,
|
|
77
|
+
STOP,
|
|
78
|
+
PREVIOUS,
|
|
79
|
+
NEXT,
|
|
80
|
+
REWIND,
|
|
81
|
+
FORWARD,
|
|
82
|
+
REPEAT,
|
|
83
|
+
RANDOM,
|
|
84
|
+
SCREENSHOT,
|
|
85
|
+
SCREENSHOT_CLIP,
|
|
86
|
+
SEPARATOR,
|
|
87
|
+
WINDOW_SCREENSHOT,
|
|
88
|
+
WINDOW_SCREENSHOT_CLIP,
|
|
89
|
+
AREA_SCREENSHOT,
|
|
90
|
+
AREA_SCREENSHOT_CLIP,
|
|
91
|
+
TOUCHPAD,
|
|
92
|
+
TOUCHPAD_ON,
|
|
93
|
+
TOUCHPAD_OFF,
|
|
94
|
+
LOGOUT,
|
|
95
|
+
SHUTDOWN,
|
|
96
|
+
HOME,
|
|
97
|
+
CALCULATOR,
|
|
98
|
+
SEARCH,
|
|
99
|
+
EMAIL,
|
|
100
|
+
SCREENSAVER,
|
|
101
|
+
HELP,
|
|
102
|
+
TERMINAL,
|
|
103
|
+
WWW,
|
|
104
|
+
VIDEO_OUT,
|
|
105
|
+
ROTATE_VIDEO,
|
|
106
|
+
ROTATE_VIDEO_LOCK,
|
|
107
|
+
SCREENREADER,
|
|
108
|
+
ON_SCREEN_KEYBOARD,
|
|
109
|
+
INCREASE_TEXT,
|
|
110
|
+
DECREASE_TEXT,
|
|
111
|
+
TOGGLE_CONTRAST,
|
|
112
|
+
SUSPEND,
|
|
113
|
+
HIBERNATE,
|
|
114
|
+
SCREEN_BRIGHTNESS_UP,
|
|
115
|
+
SCREEN_BRIGHTNESS_DOWN,
|
|
116
|
+
KEYBOARD_BRIGHTNESS_UP,
|
|
117
|
+
KEYBOARD_BRIGHTNESS_DOWN,
|
|
118
|
+
KEYBOARD_BRIGHTNESS_TOGGLE,
|
|
119
|
+
BATTERY,
|
|
120
|
+
LAST,
|
|
121
|
+
}
|
|
122
|
+
enum MouseDwellDirection {
|
|
123
|
+
LEFT,
|
|
124
|
+
RIGHT,
|
|
125
|
+
UP,
|
|
126
|
+
DOWN,
|
|
127
|
+
}
|
|
128
|
+
enum MouseDwellMode {
|
|
129
|
+
WINDOW,
|
|
130
|
+
GESTURE,
|
|
131
|
+
}
|
|
132
|
+
enum NotificationScreenDisplay {
|
|
133
|
+
PRIMARY_SCREEN,
|
|
134
|
+
ACTIVE_SCREEN,
|
|
135
|
+
FIXED_SCREEN,
|
|
136
|
+
}
|
|
137
|
+
enum PadButtonAction {
|
|
138
|
+
NONE,
|
|
139
|
+
HELP,
|
|
140
|
+
SWITCH_MONITOR,
|
|
141
|
+
KEYBINDING,
|
|
142
|
+
}
|
|
143
|
+
enum PointerAccelProfile {
|
|
144
|
+
DEFAULT,
|
|
145
|
+
FLAT,
|
|
146
|
+
ADAPTIVE,
|
|
147
|
+
}
|
|
148
|
+
enum ProxyMode {
|
|
149
|
+
NONE,
|
|
150
|
+
MANUAL,
|
|
151
|
+
AUTO,
|
|
152
|
+
}
|
|
153
|
+
enum ScreensaverMode {
|
|
154
|
+
BLANK_ONLY,
|
|
155
|
+
RANDOM,
|
|
156
|
+
SINGLE,
|
|
157
|
+
}
|
|
158
|
+
enum StylusButtonAction {
|
|
159
|
+
DEFAULT,
|
|
160
|
+
MIDDLE,
|
|
161
|
+
RIGHT,
|
|
162
|
+
BACK,
|
|
163
|
+
FORWARD,
|
|
164
|
+
DISABLED,
|
|
165
|
+
}
|
|
166
|
+
enum TabletMapping {
|
|
167
|
+
ABSOLUTE,
|
|
168
|
+
RELATIVE,
|
|
169
|
+
}
|
|
170
|
+
enum TitlebarAction {
|
|
171
|
+
TOGGLE_SHADE,
|
|
172
|
+
TOGGLE_MAXIMIZE,
|
|
173
|
+
TOGGLE_MAXIMIZE_HORIZONTALLY,
|
|
174
|
+
TOGGLE_MAXIMIZE_VERTICALLY,
|
|
175
|
+
TOGGLE_STUCK,
|
|
176
|
+
TOGGLE_ABOVE,
|
|
177
|
+
MINIMIZE,
|
|
178
|
+
NONE,
|
|
179
|
+
LOWER,
|
|
180
|
+
MENU,
|
|
181
|
+
}
|
|
182
|
+
enum TitlebarScrollAction {
|
|
183
|
+
SHADE,
|
|
184
|
+
OPACITY,
|
|
185
|
+
NONE,
|
|
186
|
+
}
|
|
187
|
+
enum ToolbarIconSize {
|
|
188
|
+
SMALL,
|
|
189
|
+
LARGE,
|
|
190
|
+
}
|
|
191
|
+
enum ToolbarStyle {
|
|
192
|
+
BOTH,
|
|
193
|
+
BOTH_HORIZ,
|
|
194
|
+
ICONS,
|
|
195
|
+
TEXT,
|
|
196
|
+
}
|
|
197
|
+
enum TouchpadClickMethod {
|
|
198
|
+
DEFAULT,
|
|
199
|
+
NONE,
|
|
200
|
+
AREAS,
|
|
201
|
+
FINGERS,
|
|
202
|
+
}
|
|
203
|
+
enum TouchpadHandedness {
|
|
204
|
+
RIGHT,
|
|
205
|
+
LEFT,
|
|
206
|
+
MOUSE,
|
|
207
|
+
}
|
|
208
|
+
enum VisualBellType {
|
|
209
|
+
FULLSCREEN_FLASH,
|
|
210
|
+
FRAME_FLASH,
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Name of the imported GIR library
|
|
214
|
+
* `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
|
|
215
|
+
*/
|
|
216
|
+
const __name__: string;
|
|
217
|
+
/**
|
|
218
|
+
* Version of the imported GIR library
|
|
219
|
+
* `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
|
|
220
|
+
*/
|
|
221
|
+
const __version__: string;
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
export default CDesktopEnums;
|
|
225
|
+
// END
|
package/package.json
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@girs/cdesktopenums-3.0",
|
|
3
|
+
"version": "3.0.0-4.0.0-beta.3",
|
|
4
|
+
"description": "GJS TypeScript type definitions for CDesktopEnums-3.0, generated from library version 3.0.0",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"module": "cdesktopenums-3.0.js",
|
|
7
|
+
"main": "cdesktopenums-3.0.js",
|
|
8
|
+
"exports": {
|
|
9
|
+
"./ambient": {
|
|
10
|
+
"types": "./cdesktopenums-3.0-ambient.d.ts",
|
|
11
|
+
"import": "./cdesktopenums-3.0-ambient.js",
|
|
12
|
+
"default": "./cdesktopenums-3.0-ambient.js"
|
|
13
|
+
},
|
|
14
|
+
"./import": {
|
|
15
|
+
"types": "./cdesktopenums-3.0-import.d.ts",
|
|
16
|
+
"import": "./cdesktopenums-3.0-import.js",
|
|
17
|
+
"default": "./cdesktopenums-3.0-import.js"
|
|
18
|
+
},
|
|
19
|
+
".": {
|
|
20
|
+
"types": "./cdesktopenums-3.0.d.ts",
|
|
21
|
+
"import": "./cdesktopenums-3.0.js",
|
|
22
|
+
"default": "./cdesktopenums-3.0.js"
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
"scripts": {
|
|
26
|
+
"test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit cdesktopenums-3.0.d.ts"
|
|
27
|
+
},
|
|
28
|
+
"dependencies": {
|
|
29
|
+
"@girs/gjs": "^4.0.0-beta.3",
|
|
30
|
+
"@girs/gobject-2.0": "^2.80.0-4.0.0-beta.3"
|
|
31
|
+
},
|
|
32
|
+
"devDependencies": {
|
|
33
|
+
"typescript": "*"
|
|
34
|
+
},
|
|
35
|
+
"keywords": [
|
|
36
|
+
"Gir",
|
|
37
|
+
"TypeScript",
|
|
38
|
+
"types",
|
|
39
|
+
"GObject-Introspection",
|
|
40
|
+
"GJS",
|
|
41
|
+
"CDesktopEnums-3.0"
|
|
42
|
+
],
|
|
43
|
+
"author": "ts-for-gir",
|
|
44
|
+
"license": "MIT",
|
|
45
|
+
"repository": {
|
|
46
|
+
"type": "git",
|
|
47
|
+
"url": "git+https://github.com/gjsify/ts-for-gir.git"
|
|
48
|
+
},
|
|
49
|
+
"bugs": {
|
|
50
|
+
"url": "https://github.com/gjsify/ts-for-gir/issues"
|
|
51
|
+
},
|
|
52
|
+
"homepage": "https://github.com/gjsify/types/tree/main/cdesktopenums-3.0#readme"
|
|
53
|
+
}
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
// General settings for code interpretation
|
|
4
|
+
"target": "ESNext",
|
|
5
|
+
"module": "ESNext",
|
|
6
|
+
"lib": ["ESNext"],
|
|
7
|
+
"types": [],
|
|
8
|
+
"experimentalDecorators": true,
|
|
9
|
+
"moduleResolution": "node",
|
|
10
|
+
"noEmit": true,
|
|
11
|
+
"noEmitOnError": false,
|
|
12
|
+
"baseUrl": "./",
|
|
13
|
+
"rootDir": ".",
|
|
14
|
+
// General settings for code generation
|
|
15
|
+
"removeComments": false,
|
|
16
|
+
"inlineSourceMap": false,
|
|
17
|
+
"inlineSources": false,
|
|
18
|
+
"newLine": "LF"
|
|
19
|
+
},
|
|
20
|
+
"include": ["./cdesktopenums-3.0.d.ts"]
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
|