@ts-for-gir/lib 3.0.0-beta.11

package/templates/Gjs/ui/dialog.d.ts

@@ -0,0 +1,78 @@
+// https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/dialog.js
+
+<% const Clutter = dep.find('Clutter') %>
+<% const St = dep.find('St') %>
+
+<%_ if(noNamespace){ _%>
+    import type * as Clutter from '../<%= Clutter.packageName %>.js';
+    import type * as St from '../<%= St.packageName %>.js';
+<%_ } else { _%>
+    import type Clutter from '../<%= Clutter.packageName %>.js';
+    import type St from '../<%= St.packageName %>.js';
+<%_ } _%>
+
+export interface ButtonInfo {
+    action: () => void;
+    label: string;
+    key?: number;
+    modifiers?: Clutter.ModifierType;
+    default?: boolean;
+}
+
+export class Dialog extends St.Widget {
+
+    protected _parentActor: St.Widget;
+    protected _dialog: St.BoxLayout;
+    protected _initialKeyFocus: St.Widget;
+
+    public contentLayout: St.BoxLayout;
+    public buttonLayout: St.Widget;
+    public readonly initialKeyFocus: St.Widget;
+
+    public _init(parentActor: St.Widget, styleClass?: string | null): void;
+    public makeInactive(): void;
+    public vfunc_event(event: Clutter.Event): boolean;
+    public addButton(buttonInfo: ButtonInfo): void;
+    public clearButtons(): void;
+
+    protected _createDialog(): void;
+    protected _onDestroy(): void;
+    protected _setInitialKeyFocus(actor: St.Widget): void;
+}
+
+export class MessageDialogContent extends St.BoxLayout {
+    public title: string;
+    public description: string;
+
+    constructor(params: St.BoxLayout.ConstructorProperties);
+    public _init(params: St.BoxLayout.ConstructorProperties): void;
+
+    protected _onDestroy(): void;
+    protected _updateTitleStyle(): void;
+}
+
+export class ListSection extends St.BoxLayout {
+
+    protected _listScrollView: St.ScrollView;
+    protected _title: St.Label;
+
+    public list: St.BoxLayout;
+    public title: string;
+    public label_actor: St.Label;
+
+    constructor(params: St.BoxLayout.ConstructorProperties);
+    public _init(params: St.BoxLayout.ConstructorProperties): void;
+}
+
+export class ListSectionItem extends St.BoxLayout {
+
+    protected _iconActorBin: St.Bin;
+    protected _title: St.Label;
+
+    public title: string;
+    public description: string;
+    public iconActor: St.Widget;
+
+    constructor(params: { style_class?: string | null });
+    public _init(params: { style_class?: string | null }): void;
+}

package/templates/Gjs/ui/dialog.js

@@ -0,0 +1,6 @@
+<% if(moduleType === 'esm') { %>
+    export imports.ui.dialog;
+<% } else { %>  
+    module.exports = imports.ui.dialog;
+<% } %>
+  

package/templates/Gjs/ui/dnd.d.ts

@@ -0,0 +1,127 @@
+// https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/dnd.js
+
+<% const Meta = dep.find('Meta') %>
+<% const Clutter = dep.find('Clutter') %>
+
+<%_ if(noNamespace){ _%>
+    import type * as Meta from '../<%= Meta.packageName %>.js';
+    import type * as Clutter from '../<%= Clutter.packageName %>.js';
+<%_ } else { _%>
+    import type Meta from '../<%= Meta.packageName %>.js';
+    import type Clutter from '../<%= Clutter.packageName %>.js';
+<%_ } _%>
+
+import { EventEmitter } from '../misc/signals.js';
+
+export enum DragMotionResult {
+    NO_DROP =   0,
+    COPY_DROP = 1,
+    MOVE_DROP = 2,
+    CONTINUE =  3,
+}
+
+export enum DragState {
+    INIT =      0,
+    DRAGGING =  1,
+    CANCELLED = 2,
+}
+
+export enum DragDropResult {
+    FAILURE =  0,
+    SUCCESS =  1,
+    CONTINUE = 2,
+}
+
+export function addDragMonitor(monitor: _Draggable): void;
+
+export function removeDragMonitor(monitor: _Draggable): void;
+
+declare namespace _Draggable {
+    export interface ConstructorProperties {
+        manualMode?: boolean;
+        timeoutThreshold?: number;
+        restoreOnSuccess?: boolean;
+        dragActorMaxSize?: number;
+        dragActorOpacity?: number;
+    }
+}
+
+declare class _Draggable extends EventEmitter {
+
+    public actor: Clutter.Actor;
+
+    constructor(actor: Clutter.Actor, params: _Draggable.ConstructorProperties);
+
+    /**
+     * fakeRelease:
+     *
+     * Fake a release event.
+     * Must be called if you want to intercept release events on draggable
+     * actors for other purposes (for example if you're using
+     * PopupMenu.ignoreRelease())
+     */
+    public fakeRelease(): void;
+
+    /**
+     * startDrag:
+     * @param stageX: X coordinate of event
+     * @param stageY: Y coordinate of event
+     * @param time: Event timestamp
+     * @param sequence: Event sequence
+     * @param device: device that originated the event
+     *
+     * Directly initiate a drag and drop operation from the given actor.
+     * This function is useful to call if you've specified manualMode
+     * for the draggable.
+     */
+    public startDrag(stageX: number, stageY: number, time: number, sequence?: Clutter.EventSequence, device?: Clutter.InputDevice): void;
+
+    protected _onButtonPress(actor: Clutter.Actor, event: Clutter.Event): boolean;
+    protected _onTouchEvent(actor: Clutter.Actor, event: Clutter.Event): boolean;
+    protected _grabDevice(actor: Clutter.Actor, pointer: Clutter.InputDevice, touchSequence: Clutter.EventSequence): boolean;
+    protected _ungrabDevice(): void;
+    protected _grabActor(device: Clutter.InputDevice, touchSequence: Clutter.EventSequence): void;
+    protected _ungrabActor(): void;
+    protected _grabEvents(device: Clutter.InputDevice, touchSequence: Clutter.EventSequence): void;
+    protected _ungrabEvents(): void;
+    protected _eventIsRelease(event: Clutter.Event): boolean;
+    protected _onEvent(actor: Clutter.Actor, event: Clutter.Event): boolean;
+    protected _updateActorPosition(origScale: number, origDragOffsetX: number, origDragOffsetY: number, transX: number, transY: number): void;
+    protected _maybeStartDrag(event: Clutter.Event): void;
+    protected _pickTargetActor(): Clutter.Actor;
+    protected _updateDragHover(): void;
+    protected _queueUpdateDragHover(): void;
+    protected _updateDragPosition(event: Clutter.Event): void;
+    protected _dragActorDropped(event: Clutter.Event): void;
+    protected _getRestoreLocation(): [number, number, number];
+    protected _cancelDrag(eventTime: number): void;
+    protected _restoreDragActor(eventTime: number): void;
+    protected _animateDragEnd(eventTime: number, params: { opacity: number; mode: Clutter.AnimationMode; onComplete: () => void; }): void;
+    protected _finishAnimation(): void;
+    protected _onAnimationComplete(dragActor: Clutter.Actor, eventTime: number): void;
+    protected _dragComplete(): void;
+}
+
+/**
+ * makeDraggable:
+ * @param actor: Source actor
+ * @param params: Additional parameters
+ * @returns a new Draggable
+ *
+ * Create an object which controls drag and drop for the given actor.
+ *
+ * If %manualMode is %true in @params, do not automatically start
+ * drag and drop on click
+ *
+ * If %dragActorMaxSize is present in @params, the drag actor will
+ * be scaled down to be no larger than that size in pixels.
+ *
+ * If %dragActorOpacity is present in @params, the drag actor will
+ * will be set to have that opacity during the drag.
+ *
+ * Note that when the drag actor is the source actor and the drop
+ * succeeds, the actor scale and opacity aren't reset; if the drop
+ * target wants to reuse the actor, it's up to the drop target to
+ * reset these values.
+ */
+export function makeDraggable(actor: Clutter.Actor, params: any): _Draggable;

package/templates/Gjs/ui/dnd.js

@@ -0,0 +1,6 @@
+<% if(moduleType === 'esm') { %>
+    export imports.ui.dnd;
+<% } else { %>  
+    module.exports = imports.ui.dnd;
+<% } %>
+  

package/templates/Gjs/ui/iconGrid.d.ts

@@ -0,0 +1,172 @@
+// https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/iconGrid.js
+
+<% const Clutter = dep.find('Clutter') %>
+<% const St = dep.find('St') %>
+<% const shell = dep.find('Shell') %>
+
+<%_ if(noNamespace){ _%>
+    import type * as Clutter from '../<%= Clutter.packageName %>.js';
+    import type * as St from '../<%= St.packageName %>.js';
+    import type * as Shell from '../<%= shell.packageName %>.js';
+<%_ } else { _%>
+    import type Clutter from '../<%= Clutter.packageName %>.js';
+    import type St from '../<%= St.packageName %>.js';
+    import type Shell from '../<%= shell.packageName %>.js';
+<%_ } _%>
+
+export namespace BaseIcon {
+    export interface ConstructorProperties {
+        createIcon?: any | null;
+        setSizeManually?: boolean;
+        showLabel?: boolean
+    }
+}
+
+export class BaseIcon extends Shell.SquareBin {
+
+    public createIcon: any | null;
+    public icon: St.Icon | null;
+    public label: St.Label | null;
+
+    protected _setSizeManually?: boolean;
+
+    constructor(label: string, params?: BaseIcon.ConstructorProperties)
+
+    public _init(params?: Shell.SquareBin.ConstructorProperties): void;
+    public _init(label: string, params?: BaseIcon.ConstructorProperties): void;
+
+}
+
+export namespace IconGrid {
+    export interface ConstructorProperties {
+        allow_incomplete_pages?: boolean;
+        orientation?: Clutter.Orientation;
+        columns_per_page: number;
+        rows_per_page: number;
+        page_halign: Clutter.ActorAlign;
+        page_padding: Clutter.Margin;
+        page_valign: Clutter.ActorAlign;
+        last_row_align: Clutter.ActorAlign;
+        column_spacing: number;
+        row_spacing: number;
+    }
+}
+
+export class IconGrid extends St.Viewport {
+
+    public currentPage: number;
+    public readonly nPages: number;
+    public readonly itemsPerPage: number;
+
+    protected _currentPage: number;
+
+    constructor(layoutParams?: IconGrid.ConstructorProperties);
+
+    /** @hidden */
+    public _init(params?: St.Viewport.ConstructorProperties): void;
+    public _init(layoutParams?: IconGrid.ConstructorProperties): void;
+
+    protected _childAdded(grid: IconGrid, child: St.Widget): void;
+    protected _ensureItemIsVisible(item: St.Widget): void;
+    protected _setGridMode(modeIndex: number): void;
+    protected _findBestModeForSize(width: number, height: number): void;
+    protected _childRemoved(grid: IconGrid, child: St.Widget): void;
+
+    /**
+     * addItem:
+     * @param item: item to append to the grid
+     * @param page: page number
+     * @param index: position in the page
+     *
+     * Adds @item to the grid. @item must not be part of the grid.
+     *
+     * If @index exceeds the number of items per page, @item will
+     * be added to the next page.
+     *
+     * @page must be a number between 0 and the number of pages.
+     * Adding to the page after next will create a new page.
+     */
+    public addItem(item: Clutter.Actor, page?: number, index?: number): void;
+
+    /**
+     * appendItem:
+     * @param item: item to append to the grid
+     *
+     * Appends @item to the grid. @item must not be part of the grid.
+     */
+    appendItem(item: Clutter.Actor): void;
+
+    /**
+     * moveItem:
+     * @param item: item to move
+     * @param newPage: new page of the item
+     * @param newPosition: new page of the item
+     *
+     * Moves @item to the grid. @item must be part of the grid.
+     */
+    moveItem(item: Clutter.Actor, newPage: number, newPosition: number): void;
+
+    /**
+     * removeItem:
+     * @param item: item to remove from the grid
+     *
+     * Removes @item to the grid. @item must be part of the grid.
+     */
+    removeItem(item: Clutter.Actor): void;
+
+    /**
+     * goToPage:
+     * @param pageIndex: page index
+     * @param animate: animate the page transition
+     *
+     * Moves the current page to @pageIndex. @pageIndex must be a valid page
+     * number.
+     */
+    goToPage(pageIndex: number, animate?: boolean): void;
+
+    /**
+     * getItemPage:
+     * @param item: the item
+     *
+     * Retrieves the page @item is in, or -1 if @item is not part of the grid.
+     *
+     * @returns the page where @item is in
+     */
+    getItemPage(item: BaseIcon): number;
+
+    /**
+     * getItemPosition:
+     * @param item: the item
+     *
+     * Retrieves the position of @item is its page, or -1 if @item is not
+     * part of the grid.
+     *
+     * @returns the page and position of @item
+     */
+    getItemPosition(item: BaseIcon): [number, number];
+
+    /**
+     * getItemAt:
+     * @param {int} page: the page
+     * @param {int} position: the position in page
+     *
+     * Retrieves the item at @page and @position.
+     *
+     * @returns The item at @page and @position, or null
+     */
+    getItemAt(page: number, position: number): BaseIcon | null;
+
+    /**
+     * getItemsAtPage:
+     * @param page: the page index
+     *
+     * Retrieves the children at page @page, including invisible children.
+     *
+     * @returns an array of {Clutter.Actor}s
+     */
+    getItemsAtPage(page: number): Clutter.Actor[];
+
+    setGridModes(modes: [number, number][]): void;
+
+    getDropTarget(x: number, y: number): [number, number];
+}

package/templates/Gjs/ui/iconGrid.js

@@ -0,0 +1,6 @@
+<% if(moduleType === 'esm') { %>
+    export imports.ui.iconGrid;
+<% } else { %>  
+    module.exports = imports.ui.iconGrid;
+<% } %>
+