mirror of
https://github.com/Bismuth-Forge/bismuth.git
synced 2024-09-17 11:37:10 +03:00
docs: 📝 add a bit more docs to KWin Scripting interface
This commit is contained in:
parent
78957f4cad
commit
aea4e9f6c7
14
src/extern/kwin.d.ts
vendored
14
src/extern/kwin.d.ts
vendored
@ -9,6 +9,9 @@
|
|||||||
// TODO: Register the rest of the API and document it according to KWin documentation.
|
// TODO: Register the rest of the API and document it according to KWin documentation.
|
||||||
// Maybe it is even possible to generate this API. If so, this could be upstreamed.
|
// Maybe it is even possible to generate this API. If so, this could be upstreamed.
|
||||||
declare namespace KWin {
|
declare namespace KWin {
|
||||||
|
/**
|
||||||
|
* Wrapper for all available KWin API from various places.
|
||||||
|
*/
|
||||||
interface Api {
|
interface Api {
|
||||||
workspace: KWin.WorkspaceWrapper;
|
workspace: KWin.WorkspaceWrapper;
|
||||||
options: KWin.Options;
|
options: KWin.Options;
|
||||||
@ -16,13 +19,24 @@ declare namespace KWin {
|
|||||||
}
|
}
|
||||||
|
|
||||||
interface KWin {
|
interface KWin {
|
||||||
|
/**
|
||||||
|
* Represents KWin::Script::readConfig
|
||||||
|
*/
|
||||||
readConfig(key: string, defaultValue?: any): any;
|
readConfig(key: string, defaultValue?: any): any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents KWin::Script::registerShortcut
|
||||||
|
*/
|
||||||
registerShortcut(
|
registerShortcut(
|
||||||
title: string,
|
title: string,
|
||||||
text: string,
|
text: string,
|
||||||
keySequence: string,
|
keySequence: string,
|
||||||
callback: any
|
callback: any
|
||||||
): boolean;
|
): boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enum value of ClientAreaOption enum in KWin::JSEngineGlobalMethodsWrapper
|
||||||
|
*/
|
||||||
PlacementArea: number;
|
PlacementArea: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user