@girs/gdl-3 4.3.0 → 4.5.0

package/gdl-3.d.ts

@@ -47,19 +47,19 @@ export namespace Gdl {
         /**
          * Buttons display only icons in the dockbar.
          */
-        ICONS,
+        ICONS = 0,
         /**
          * Buttons display only text labels in the dockbar.
          */
-        TEXT,
+        TEXT = 1,
         /**
          * Buttons display text and icons in the dockbar.
          */
-        BOTH,
+        BOTH = 2,
         /**
          * identical to `GDL_DOCK_BAR_BOTH`.
          */
-        AUTO,
+        AUTO = 3,
     }
 
 
@@ -71,11 +71,11 @@ export namespace Gdl {
         /**
          * Display a small cross
          */
-        CLOSE,
+        CLOSE = 0,
         /**
          * Display a small triangle
          */
-        ICONIFY,
+        ICONIFY = 1,
     }
 
 
@@ -94,31 +94,31 @@ export namespace Gdl {
         /**
          * No position defined
          */
-        NONE,
+        NONE = 0,
         /**
          * Dock object on the top
          */
-        TOP,
+        TOP = 1,
         /**
          * Dock object on the bottom
          */
-        BOTTOM,
+        BOTTOM = 2,
         /**
          * Dock object on the right
          */
-        RIGHT,
+        RIGHT = 3,
         /**
          * Dock object on the left
          */
-        LEFT,
+        LEFT = 4,
         /**
          * Dock object on top of the other
          */
-        CENTER,
+        CENTER = 5,
         /**
          * Dock object in its own window
          */
-        FLOATING,
+        FLOATING = 6,
     }
 
 
@@ -137,38 +137,45 @@ export namespace Gdl {
         /**
          * Tabs display only text labels.
          */
-        TEXT,
+        TEXT = 0,
         /**
          * Tabs display only icons.
          */
-        ICON,
+        ICON = 1,
         /**
          * Tabs display text and icons.
          */
-        BOTH,
+        BOTH = 2,
         /**
          * Same as `GDL_SWITCHER_STYLE_BOTH`.
          */
-        TOOLBAR,
+        TOOLBAR = 3,
         /**
          * Tabs display like notebook tabs.
          */
-        TABS,
+        TABS = 4,
         /**
          * Do not display tabs.
          */
-        NONE,
+        NONE = 5,
     }
 
 
+    /**
+     * @default master
+     */
     const DOCK_MASTER_PROPERTY: string;
 
+    /**
+     * @default name
+     */
     const DOCK_NAME_PROPERTY: string;
 
     /**
      * Minimum shift count to be used for user defined flags, to be stored in
      * {@link Gdl.DockObject}.flags.
      * @deprecated since 3.6: Use a private flag instead
+     * @default 8
      */
     const DOCK_OBJECT_FLAGS_SHIFT: number;
 
@@ -217,55 +224,55 @@ export namespace Gdl {
         /**
          * Normal dock item
          */
-        NORMAL,
+        NORMAL = 0,
         /**
          * item cannot be undocked
          */
-        NEVER_FLOATING,
+        NEVER_FLOATING = 1,
         /**
          * item cannot be docked vertically
          */
-        NEVER_VERTICAL,
+        NEVER_VERTICAL = 2,
         /**
          * item cannot be docked horizontally
          */
-        NEVER_HORIZONTAL,
+        NEVER_HORIZONTAL = 4,
         /**
          * item is locked, it cannot be moved around
          */
-        LOCKED,
+        LOCKED = 8,
         /**
          * item cannot be docked at top
          */
-        CANT_DOCK_TOP,
+        CANT_DOCK_TOP = 16,
         /**
          * item cannot be docked at bottom
          */
-        CANT_DOCK_BOTTOM,
+        CANT_DOCK_BOTTOM = 32,
         /**
          * item cannot be docked left
          */
-        CANT_DOCK_LEFT,
+        CANT_DOCK_LEFT = 64,
         /**
          * item cannot be docked right
          */
-        CANT_DOCK_RIGHT,
+        CANT_DOCK_RIGHT = 128,
         /**
          * item cannot be docked at center
          */
-        CANT_DOCK_CENTER,
+        CANT_DOCK_CENTER = 256,
         /**
          * item cannot be closed
          */
-        CANT_CLOSE,
+        CANT_CLOSE = 512,
         /**
          * item cannot be iconified
          */
-        CANT_ICONIFY,
+        CANT_ICONIFY = 1024,
         /**
          * item doesn't have a grip
          */
-        NO_GRIP,
+        NO_GRIP = 2048,
     }
 
 
@@ -285,19 +292,19 @@ export namespace Gdl {
         /**
          * item is in a drag operation
          */
-        IN_DRAG,
+        IN_DRAG = 256,
         /**
          * item is in a predrag operation
          */
-        IN_PREDRAG,
+        IN_PREDRAG = 512,
         /**
          * item is iconified
          */
-        ICONIFIED,
+        ICONIFIED = 1024,
         /**
          * indicates the user has started an action on the dock item
          */
-        USER_ACTION,
+        USER_ACTION = 2048,
     }
 
 
@@ -319,19 +326,19 @@ export namespace Gdl {
         /**
          * Object is created and destroyed by the master, not the user
          */
-        AUTOMATIC,
+        AUTOMATIC = 1,
         /**
          * Object has a parent
          */
-        ATTACHED,
+        ATTACHED = 2,
         /**
          * Object is currently part of a rearrangement
          */
-        IN_REFLOW,
+        IN_REFLOW = 4,
         /**
          * Object will be removed
          */
-        IN_DETACH,
+        IN_DETACH = 8,
     }
 
 
@@ -351,11 +358,11 @@ export namespace Gdl {
         /**
          * The parameter is to be exported for later layout rebuilding
          */
-        EXPORT,
+        EXPORT = 256,
         /**
          * The parameter must be set after adding the children objects
          */
-        AFTER,
+        AFTER = 512,
     }
 
 
@@ -588,6 +595,7 @@ export namespace Gdl {
          * It does not search only in the children of this particular dock widget.
          * @param name An item name
          * @returns A {@link Gdl.DockPlaceholder} object or `null`
+         * @deprecated since 3.6: This function is always returning `null`.
          */
         get_placeholder_by_name(name: string): DockPlaceholder;
 
@@ -613,6 +621,7 @@ export namespace Gdl {
          * Sets whether or not a floating dock window should be prevented from
          * appearing in the system taskbar.
          * @param skip `true` if floating docks should be prevented from appearing in the taskbar
+         * @since 3.6
          */
         set_skip_taskbar(skip: boolean): void;
 
@@ -625,11 +634,13 @@ export namespace Gdl {
         /**
          * Show a preview window used to materialize the dock target.
          * @param rect The position and the size of the preview window
+         * @deprecated since 3.6: Use gdl_dock_show_preview instead.
          */
         xor_rect(rect: Gdk.Rectangle): void;
 
         /**
          * Hide the preview window used to materialize the dock target.
+         * @deprecated since 3.6: Use gdl_dock_hide_preview instead.
          */
         xor_rect_hide(): void;
     }
@@ -757,6 +768,7 @@ export namespace Gdl {
         /**
          * Retrieves the orientation of the `dockbar`.
          * @returns the orientation of the `docbar`
+         * @deprecated since 3.6: Use `gtk_orientable_get_orientation()` instead.
          */
         get_orientation(): Gtk.Orientation;
 
@@ -775,6 +787,7 @@ export namespace Gdl {
         /**
          * Set the orientation of the `dockbar`.
          * @param orientation the new orientation
+         * @deprecated since 3.6: Use `gtk_orientable_set_orientation()` instead.
          */
         set_orientation(orientation: Gtk.Orientation): void;
 
@@ -821,13 +834,13 @@ export namespace Gdl {
              * @signal
              * @run-first
              */
-            "dock-drag-end": (arg0: boolean) => void;
+            "dock-drag-end": (cancel: boolean) => void;
             /**
              * Signals that a dock item dragging motion event has occured.
              * @signal
              * @run-first
              */
-            "dock-drag-motion": (arg0: Gdk.Device, arg1: number, arg2: number) => void;
+            "dock-drag-motion": (device: Gdk.Device, x: number, y: number) => void;
             /**
              * The ::move-focus-child signal is emitted when a change of focus is
              * requested for the child widget of a dock item.  The `dir` parameter
@@ -837,7 +850,7 @@ export namespace Gdl {
              * @action
              * @run-last
              */
-            "move-focus-child": (arg0: Gtk.DirectionType) => void;
+            "move-focus-child": (dir: Gtk.DirectionType) => void;
             /**
              * Signals that this dock has been selected from a switcher.
              * @signal
@@ -1086,6 +1099,7 @@ export namespace Gdl {
         /**
          * Retrieves the behavior of the item.
          * @returns the behavior of the item.
+         * @since 3.6
          */
         get_behavior_flags(): DockItemBehavior;
 
@@ -1094,12 +1108,14 @@ export namespace Gdl {
          * no child widget. The returned widget does not have a reference
          * added, so you do not need to unref it.
          * @returns pointer to child of the {@link Gdl.DockItem}
+         * @since 3.6
          */
         get_child(): Gtk.Widget;
 
         /**
          * Gets the size and the position of the drag window in pixels.
          * @param rect A pointer to a {@link Gdk.Rectangle} that will receive the drag position
+         * @since 3.6
          */
         get_drag_area(rect: Gdk.Rectangle): void;
 
@@ -1112,6 +1128,7 @@ export namespace Gdl {
         /**
          * Retrieves the orientation of the object.
          * @returns the orientation of the object.
+         * @since 3.6
          */
         get_orientation(): Gtk.Orientation;
 
@@ -1148,12 +1165,14 @@ export namespace Gdl {
          * Checks whether a given {@link Gdl.DockItem} is closed. It can be only hidden or
          * detached.
          * @returns `true` if the dock item is closed.
+         * @since 3.6
          */
         is_closed(): boolean;
 
         /**
          * Checks whether a given {@link Gdl.DockItem} is iconified.
          * @returns `true` if the dock item is iconified.
+         * @since 3.6
          */
         is_iconified(): boolean;
 
@@ -1161,6 +1180,7 @@ export namespace Gdl {
          * Checks whether a given {@link Gdl.DockItem} is a placeholder created by the
          * {@link Gdl.DockLayout} object and does not contain a child.
          * @returns `true` if the dock item is a placeholder
+         * @since 3.6
          */
         is_placeholder(): boolean;
 
@@ -1186,6 +1206,7 @@ export namespace Gdl {
          * Checks whether a given {@link Gdl.DockItem} or its child widget has focus.
          * This check is performed recursively on child widgets.
          * @returns `true` if the dock item or its child widget has focus; `false` otherwise.
+         * @since 3.3.2
          */
         or_child_has_focus(): boolean;
 
@@ -1199,6 +1220,7 @@ export namespace Gdl {
          * This function sets the behavior of the dock item.
          * @param behavior Behavior flags to turn on
          * @param clear Whether to clear state before turning on `flags`
+         * @since 3.6
          */
         set_behavior_flags(behavior: DockItemBehavior, clear: boolean): void;
 
@@ -1210,6 +1232,7 @@ export namespace Gdl {
          * If a child is already present, it will be replaced. If `widget` is `null` the
          * child will be removed.
          * @param child a {@link Gtk.Widget}
+         * @since 3.6
          */
         set_child(child: Gtk.Widget | null): void;
 
@@ -1262,6 +1285,7 @@ export namespace Gdl {
         /**
          * This function sets the behavior of the dock item.
          * @param behavior Behavior flags to turn off
+         * @since 3.6
          */
         unset_behavior_flags(behavior: DockItemBehavior): void;
     }
@@ -1359,6 +1383,7 @@ export namespace Gdl {
          * @param builder a {@link Gtk.Builder}
          * @param child child to add
          * @param type kind of child or `null`
+         * @since 2.12
          */
         add_child(builder: Gtk.Builder, child: GObject.Object, type: string | null): void;
 
@@ -1370,6 +1395,7 @@ export namespace Gdl {
          * @param builder {@link Gtk.Builder} used to construct this object
          * @param name name of child to construct
          * @returns the constructed child
+         * @since 2.12
          */
         construct_child<T = GObject.Object>(builder: Gtk.Builder, name: string): T;
 
@@ -1380,6 +1406,7 @@ export namespace Gdl {
          * @param child child object or `null` for non-child tags
          * @param tagname the name of the tag
          * @param data user data created in custom_tag_start
+         * @since 2.12
          */
         custom_finished(builder: Gtk.Builder, child: GObject.Object | null, tagname: string, data: null): void;
 
@@ -1390,6 +1417,7 @@ export namespace Gdl {
          * @param child child object or `null` for non-child tags
          * @param tagname name of tag
          * @param data user data that will be passed in to parser functions
+         * @since 2.12
          */
         custom_tag_end(builder: Gtk.Builder, child: GObject.Object | null, tagname: string, data: null): void;
 
@@ -1399,6 +1427,7 @@ export namespace Gdl {
          * @param child child object or `null` for non-child tags
          * @param tagname name of tag
          * @returns `true` if a object has a custom implementation, `false`          if it doesn't.
+         * @since 2.12
          */
         custom_tag_start(builder: Gtk.Builder, child: GObject.Object | null, tagname: string): [boolean, GLib.MarkupParser, null];
 
@@ -1407,6 +1436,7 @@ export namespace Gdl {
          * @param builder a {@link Gtk.Builder}
          * @param childname name of child
          * @returns the internal child of the buildable object
+         * @since 2.12
          */
         get_internal_child<T = GObject.Object>(builder: Gtk.Builder, childname: string): T;
 
@@ -1417,6 +1447,7 @@ export namespace Gdl {
          * [GtkBuilder UI definition][BUILDER-UI]
          * used to construct the `buildable`.
          * @returns the name set with `gtk_buildable_set_name()`
+         * @since 2.12
          */
         get_name(): string;
 
@@ -1427,6 +1458,7 @@ export namespace Gdl {
          * `gtk_builder_add_from_file()` or `gtk_builder_add_from_string()`
          * is called on a builder.
          * @param builder a {@link Gtk.Builder}
+         * @since 2.12
          */
         parser_finished(builder: Gtk.Builder): void;
 
@@ -1435,12 +1467,14 @@ export namespace Gdl {
          * @param builder a {@link Gtk.Builder}
          * @param name name of property
          * @param value value of property
+         * @since 2.12
          */
         set_buildable_property(builder: Gtk.Builder, name: string, value: GObject.Value | any): void;
 
         /**
          * Sets the name of the `buildable` object.
          * @param name name to set
+         * @since 2.12
          */
         set_name(name: string): void;
 
@@ -1450,6 +1484,7 @@ export namespace Gdl {
          * @param builder a {@link Gtk.Builder}
          * @param child child to add
          * @param type kind of child or `null`
+         * @since 2.12
          * @virtual
          */
         vfunc_add_child(builder: Gtk.Builder, child: GObject.Object, type: string | null): void;
@@ -1461,6 +1496,7 @@ export namespace Gdl {
          * specified in the UI definition.
          * @param builder {@link Gtk.Builder} used to construct this object
          * @param name name of child to construct
+         * @since 2.12
          * @virtual
          */
         vfunc_construct_child<T = GObject.Object>(builder: Gtk.Builder, name: string): T;
@@ -1472,6 +1508,7 @@ export namespace Gdl {
          * @param child child object or `null` for non-child tags
          * @param tagname the name of the tag
          * @param data user data created in custom_tag_start
+         * @since 2.12
          * @virtual
          */
         vfunc_custom_finished(builder: Gtk.Builder, child: GObject.Object | null, tagname: string, data: null): void;
@@ -1483,6 +1520,7 @@ export namespace Gdl {
          * @param child child object or `null` for non-child tags
          * @param tagname name of tag
          * @param data user data that will be passed in to parser functions
+         * @since 2.12
          * @virtual
          */
         vfunc_custom_tag_end(builder: Gtk.Builder, child: GObject.Object | null, tagname: string, data: null): void;
@@ -1492,6 +1530,7 @@ export namespace Gdl {
          * @param builder a {@link Gtk.Builder} used to construct this object
          * @param child child object or `null` for non-child tags
          * @param tagname name of tag
+         * @since 2.12
          * @virtual
          */
         vfunc_custom_tag_start(builder: Gtk.Builder, child: GObject.Object | null, tagname: string): [boolean, GLib.MarkupParser, never];
@@ -1500,6 +1539,7 @@ export namespace Gdl {
          * Get the internal child called `childname` of the `buildable` object.
          * @param builder a {@link Gtk.Builder}
          * @param childname name of child
+         * @since 2.12
          * @virtual
          */
         vfunc_get_internal_child<T = GObject.Object>(builder: Gtk.Builder, childname: string): T;
@@ -1510,6 +1550,7 @@ export namespace Gdl {
          * {@link Gtk.Builder} sets the name based on the
          * [GtkBuilder UI definition][BUILDER-UI]
          * used to construct the `buildable`.
+         * @since 2.12
          * @virtual
          */
         vfunc_get_name(): string;
@@ -1521,6 +1562,7 @@ export namespace Gdl {
          * `gtk_builder_add_from_file()` or `gtk_builder_add_from_string()`
          * is called on a builder.
          * @param builder a {@link Gtk.Builder}
+         * @since 2.12
          * @virtual
          */
         vfunc_parser_finished(builder: Gtk.Builder): void;
@@ -1530,6 +1572,7 @@ export namespace Gdl {
          * @param builder a {@link Gtk.Builder}
          * @param name name of property
          * @param value value of property
+         * @since 2.12
          * @virtual
          */
         vfunc_set_buildable_property(builder: Gtk.Builder, name: string, value: unknown): void;
@@ -1537,6 +1580,7 @@ export namespace Gdl {
         /**
          * Sets the name of the `buildable` object.
          * @param name name to set
+         * @since 2.12
          * @virtual
          */
         vfunc_set_name(name: string): void;
@@ -1654,6 +1698,7 @@ export namespace Gdl {
         /**
          * Change the cursor when a drag operation is started.
          * @param in_drag `true` if a drag operation is started
+         * @since 3.6
          */
         set_cursor(in_drag: boolean): void;
 
@@ -1761,6 +1806,7 @@ export namespace Gdl {
         /**
          * Retrieves the master of the object.
          * @returns a {@link Gdl.DockMaster} object
+         * @since 3.6
          */
         get_master<T = GObject.Object>(): T;
 
@@ -1975,6 +2021,7 @@ export namespace Gdl {
         /**
          * Return an unique translated dock name.
          * @returns a new translated name. The string has to be freed with `g_free()`.
+         * @since 3.6
          */
         get_dock_name(): string;
 
@@ -2120,13 +2167,13 @@ export namespace Gdl {
              * @signal
              * @run-last
              */
-            detach: (arg0: boolean) => void;
+            detach: (recursive: boolean) => void;
             /**
              * Signals that the {@link Gdl.DockObject} has been docked.
              * @signal
              * @run-first
              */
-            dock: (arg0: DockObject, arg1: DockPlacement, arg2: unknown | null) => void;
+            dock: (requestor: DockObject, position: DockPlacement, other_data: unknown | null) => void;
             "notify::long-name": (pspec: GObject.ParamSpec) => void;
             "notify::master": (pspec: GObject.ParamSpec) => void;
             "notify::name": (pspec: GObject.ParamSpec) => void;
@@ -2437,6 +2484,7 @@ export namespace Gdl {
         /**
          * Retrieves the controller of the object.
          * @returns a {@link Gdl.DockObject} object
+         * @since 3.6
          */
         get_controller(): DockObject;
 
@@ -2444,18 +2492,21 @@ export namespace Gdl {
          * Retrieves the long name of the object. This name is an human readable string
          * which can be displayed in the user interface.
          * @returns the name of the object.
+         * @since 3.6
          */
         get_long_name(): string;
 
         /**
          * Retrieves the master of the object.
          * @returns a {@link Gdl.DockMaster} object
+         * @since 3.6
          */
         get_master<T = GObject.Object>(): T;
 
         /**
          * Retrieves the name of the object. This name is used to identify the object.
          * @returns the name of the object.
+         * @since 3.6
          */
         get_name(): string;
 
@@ -2468,12 +2519,14 @@ export namespace Gdl {
         /**
          * Retrieves a pixbuf used as the dock object icon.
          * @returns icon for dock object
+         * @since 3.6
          */
         get_pixbuf(): GdkPixbuf.Pixbuf;
 
         /**
          * Retrieves the a stock id used as the object icon.
          * @returns A stock id corresponding to the object icon.
+         * @since 3.6
          */
         get_stock_id(): string;
 
@@ -2487,6 +2540,7 @@ export namespace Gdl {
          * Determine if an object is managed by the dock master, such object is
          * destroyed automatically when it is not needed anymore.
          * @returns `true` if the object is managed automatically by the dock master.
+         * @since 3.6
          */
         is_automatic(): boolean;
 
@@ -2500,6 +2554,7 @@ export namespace Gdl {
          * Checks whether a given {@link Gdl.DockObject} is closed. It can be only hidden and
          * still in the widget hierarchy or detached.
          * @returns `true` if the dock object is closed.
+         * @since 3.6
          */
         is_closed(): boolean;
 
@@ -2513,12 +2568,14 @@ export namespace Gdl {
          * Determine if an object is frozen and is not removed immediately from the
          * widget hierarchy when it is reduced.
          * @returns `true` if the object is frozen.
+         * @since 3.6
          */
         is_frozen(): boolean;
 
         /**
          * Emits the {@link Gdl.DockMaster.SignalSignatures.layout_changed | Gdl.DockMaster::layout-changed} signal on the master of the object
          * if existing.
+         * @since 3.6
          */
         layout_changed_notify(): void;
 
@@ -2549,6 +2606,7 @@ export namespace Gdl {
          * Set the long name of the object. This name is an human readable string
          * which can be displayed in the user interface.
          * @param name a name for the object
+         * @since 3.6
          */
         set_long_name(name: string): void;
 
@@ -2556,24 +2614,28 @@ export namespace Gdl {
          * A {@link Gdl.DockObject} is managed by default by the dock master, use this function
          * to make it a manual object if you want to manage the destruction of the
          * object.
+         * @since 3.6
          */
         set_manual(): void;
 
         /**
          * Set the name of the object used to identify it.
          * @param name a name for the object
+         * @since 3.6
          */
         set_name(name: string): void;
 
         /**
          * Set a icon for a dock object using a {@link GdkPixbuf.Pixbuf}.
          * @param icon a icon or `null`
+         * @since 3.6
          */
         set_pixbuf(icon: GdkPixbuf.Pixbuf | null): void;
 
         /**
          * Set an icon for the dock object using a stock id.
          * @param stock_id a stock id
+         * @since 3.6
          */
         set_stock_id(stock_id: string): void;
 
@@ -2903,6 +2965,7 @@ export namespace Gdl {
         /**
          * Move the placeholder to the position of `object`.
          * @param object A new {@link Gdl.DockObject}
+         * @deprecated since 3.6
          */
         attach(object: DockObject): void;
     }
@@ -2916,7 +2979,7 @@ export namespace Gdl {
              * @signal
              * @run-last
              */
-            "button-pressed-handle": (arg0: Gdk.Event) => void;
+            "button-pressed-handle": (event: Gdk.Event) => void;
             "notify::item": (pspec: GObject.ParamSpec) => void;
             "notify::border-width": (pspec: GObject.ParamSpec) => void;
             "notify::child": (pspec: GObject.ParamSpec) => void;
@@ -3026,6 +3089,7 @@ export namespace Gdl {
         // Methods
         /**
          * Set the widget in "activated" state.
+         * @deprecated since 3.6
          */
         activate(): void;
 
@@ -3037,6 +3101,7 @@ export namespace Gdl {
 
         /**
          * Set the widget in "deactivated" state.
+         * @deprecated since 3.6
          */
         deactivate(): void;
     }