Gjsify LogoGjsify Logo

The #WnckWindow struct contains only private fields and should not be directly accessed.

Hierarchy

Index

Constructors

Properties

gTypeInstance: TypeInstance
parentInstance: GObject.Object
$gtype: GType<Wnck.Window>
name: string

Methods

  • activate(timestamp: number): void
  • Asks the window manager to make window the active window. The window manager may choose to raise window along with focusing it, and may decide to refuse the request (to not steal the focus if there is a more recent user activity, for example).

    This function existed before 2.10, but the timestamp argument was missing in earlier versions.

    Parameters

    • timestamp: number

      the X server timestamp of the user interaction event that caused this call to occur.

    Returns void

  • activateTransient(timestamp: number): void
  • If window has transients, activates the most likely transient instead of the window itself. Otherwise activates window.

    FIXME the ideal behavior of this function is probably to activate the most recently active window among window and its transients. This is probably best implemented on the window manager side.

    This function existed before 2.10, but the timestamp argument was missing in earlier versions.

    Parameters

    • timestamp: number

      the X server timestamp of the user interaction event that caused this call to occur.

    Returns void

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • close(timestamp: number): void
  • Closes window.

    This function existed before 2.6, but the timestamp argument was missing in earlier versions.

    Parameters

    • timestamp: number

      the X server timestamp of the user interaction event that caused this call to occur.

    Returns void

  • emit(sigName: "actions-changed", newState: WindowActions, ...args: any[]): void
  • emit(sigName: "class-changed", ...args: any[]): void
  • emit(sigName: "geometry-changed", ...args: any[]): void
  • emit(sigName: "icon-changed", ...args: any[]): void
  • emit(sigName: "name-changed", ...args: any[]): void
  • emit(sigName: "role-changed", ...args: any[]): void
  • emit(sigName: "state-changed", newState: Wnck.WindowState, ...args: any[]): void
  • emit(sigName: "type-changed", ...args: any[]): void
  • emit(sigName: "workspace-changed", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • forceFloating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freezeNotify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • getClassGroupName(): string
  • Gets the class group name from the WM_CLASS Property for window.

    The class group name is also the identifier name of the #WnckClassGroup to which window belongs.

    Returns string

  • getClassInstanceName(): string
  • Gets the class instance name from the WM_CLASS Property for window.

    The class instance name allows to differentiate windows belonging to the same class group, so that they can use different resources.

    Returns string

  • getClientWindowGeometry(): [number, number, number, number]
  • Gets the size and position of window, as last received in a ConfigureNotify event (i.e. this call does not round-trip to the server, just gets the last size we were notified of). The X and Y coordinates are relative to the root window.

    The window manager usually adds a frame around windows. If you need to know the size of window with the frame, use wnck_window_get_geometry().

    Returns [number, number, number, number]

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getGeometry(): [number, number, number, number]
  • Gets the size and position of window, including decorations. This function uses the information last received in a ConfigureNotify event and adjusts it according to the size of the frame that is added by the window manager (this call does not round-trip to the server, it just gets the last sizes that were notified). The X and Y coordinates are relative to the root window.

    If you need to know the actual size of window ignoring the frame added by the window manager, use wnck_window_get_client_window_geometry().

    Returns [number, number, number, number]

  • getGroupLeader(): number
  • Gets the group leader of the group of windows to which window belongs.

    Returns number

  • Gets the icon to be used for window. If no icon was found, a fallback icon is used. wnck_window_get_icon_is_fallback() can be used to tell if the icon is the fallback icon.

    Returns Pixbuf

  • getIconIsFallback(): boolean
  • Gets whether a default fallback icon is used for window (because none was set on window).

    Returns boolean

  • getIconName(): string
  • Gets the icon name of window, as it should be displayed for an icon (minimized state). Always returns some value, even if window has no icon name set; use wnck_window_has_icon_name() if you need to know whether the returned icon name is "real" or not.

    Contrast with wnck_window_get_name(), which returns window<!-- -->'s title, not its icon title.

    Returns string

  • Gets the mini-icon to be used for window. If no mini-icon was found, a fallback mini-icon is used. wnck_window_get_icon_is_fallback() can be used to tell if the mini-icon is the fallback mini-icon.

    Returns Pixbuf

  • getName(): string
  • Gets the name of window, as it should be displayed in a pager or tasklist. Always returns some value, even if window has no name set; use wnck_window_has_name() if you need to know whether the returned name is "real" or not.

    For icons titles, use wnck_window_get_icon_name() instead.

    Returns string

  • getPid(): number
  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getRole(): string
  • Gets the role for window. The role uniquely identifies a window among all windows that have the same client leader window.

    Returns string

  • getSessionId(): string
  • Gets the session ID for window in Latin-1 encoding. NOTE: this is invalid UTF-8. You can't display this string in a GTK+ widget without converting to UTF-8. See wnck_window_get_session_id_utf8().

    Returns string

  • getSessionIdUtf8(): string
  • Gets the session ID for window in UTF-8 encoding. The session ID should be in Latin-1 encoding, so the conversion should work, but a broken client could set a session ID that might not be convertable to UTF-8.

    Returns string

  • getSortOrder(): number
  • Gets the sort order of window, used for ordering of window in #WnckSelector and #WnckTasklist. The sort order is an internal state in libwnck. The initial value is defined when the window is created.

    Returns number

  • Gets the current workspace window is on. If the window is pinned (on all workspaces), or not on any workspaces, %NULL may be returned.

    Returns Workspace

  • getXid(): number
  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • hasIconName(): boolean
  • Checks whether or not window has an icon name. wnck_window_get_icon_name() will always return some value, even if window has no icon name set; wnck_window_has_icon_name() can be used to tell if that icon name is real or not.

    (Note that if wnck_window_has_icon_name() returns %FALSE, but wnck_window_has_name() returns %TRUE, then the name returned by wnck_window_get_icon_name() is window<!-- -->'s name. Only when both methods return %FALSE does wnck_window_get_icon_name() return a generic fallback name.)

    Returns boolean

  • hasName(): boolean
  • Checks whether or not window has a name. wnck_window_get_name() will always return some value, even if window has no name set; wnck_window_has_name() can be used to tell if that name is real or not.

    For icons titles, use wnck_window_has_icon_name() instead.

    Returns boolean

  • isAbove(): boolean
  • Gets whether window is above other windows. This state may change anytime a #WnckWindow::state-changed signal gets emitted.

    See wnck_window_make_above() for more details on this state.

    Returns boolean

  • isActive(): boolean
  • Gets whether window is the active window on its #WnckScreen.

    Returns boolean

  • isBelow(): boolean
  • Gets whether window is below other windows. This state may change anytime a #WnckWindow::state-changed signal gets emitted.

    See wnck_window_make_below() for more details on this state.

    Returns boolean

  • isFloating(): boolean
  • isFullscreen(): boolean
  • Gets whether window is fullscreen. Fullscreen state may change anytime a #WnckWindow::state-changed signal gets emitted.

    Returns boolean

  • Gets %TRUE if window appears in the current viewport of workspace.

    Parameters

    Returns boolean

  • isMaximized(): boolean
  • Gets whether window is maximized. Maximization state may change anytime a #WnckWindow::state-changed signal gets emitted.

    As for GDK, "maximized" means both vertically and horizontally. If window is maximized in only one direction, then window is not considered maximized.

    Returns boolean

  • isMaximizedHorizontally(): boolean
  • Gets whether window is maximized horizontally. Horizontal maximization state may change anytime a #WnckWindow::state-changed signal gets emitted.

    Returns boolean

  • isMaximizedVertically(): boolean
  • Gets whether window is maximized vertically. vertiVal maximization state may change anytime a #WnckWindow::state-changed signal gets emitted.

    Returns boolean

  • isMinimized(): boolean
  • Gets whether window is minimized. Minimization state may change anytime a #WnckWindow::state-changed signal gets emitted.

    Returns boolean

  • isMostRecentlyActivated(): boolean
  • Gets whether window is the most recently activated window on its #WnckScreen.

    The most recently activated window is identical to the active window for click and sloppy focus methods (since a window is always active in those cases) but differs slightly for mouse focus since there often is no active window.

    Returns boolean

  • Gets whether window appears on workspace.

    Parameters

    Returns boolean

  • isPinned(): boolean
  • Gets whether window is on all workspace. Pinned state may change anytime a #WnckWindow::workspace-changed signal gets emitted, but not when a #WnckWindow::state-changed gets emitted.

    Returns boolean

  • isShaded(): boolean
  • Gets whether window is shaded. Shade state may change anytime a #WnckWindow::state-changed signal gets emitted.

    Returns boolean

  • isSkipPager(): boolean
  • Gets whether window is included on pagers. This state may change anytime a #WnckWindow::state-changed signal gets emitted.

    Returns boolean

  • isSkipTasklist(): boolean
  • Gets whether window is included on tasklists. This state may change anytime a #WnckWindow::state-changed signal gets emitted.

    Returns boolean

  • isSticky(): boolean
  • Gets whether window is sticky. Sticky state may change anytime a #WnckWindow::state-changed signal gets emitted.

    Sticky here means "stuck to the glass", i.e. does not scroll with the viewport. In GDK/GTK+ (e.g. gdk_window_stick()/gtk_window_stick()), sticky means "stuck to the glass" and also that the window is on all workspaces. But here it only means the viewport aspect of it.

    Returns boolean

  • isVisibleOnWorkspace(workspace: Workspace): boolean
  • Like wnck_window_is_on_workspace(), but also checks that the window is in a visible state (i.e. not minimized or shaded).

    Parameters

    Returns boolean

  • keyboardMove(): void
  • Asks the window manager to start moving window via the keyboard.

    Returns void

  • keyboardSize(): void
  • Asks the window manager to start resizing window via the keyboard.

    Returns void

  • makeAbove(): void
  • Asks the window manager to put window on top of most windows (window will not be on top of focused fullscreen windows, of other windows with this setting and of dock windows).

    Returns void

  • makeBelow(): void
  • Asks the window manager to put window below most windows.

    Returns void

  • maximize(): void
  • maximizeHorizontally(): void
  • Asks the window manager to maximize horizontally window.

    Returns void

  • maximizeVertically(): void
  • Asks the window manager to maximize vertically window.

    Returns void

  • minimize(): void
  • Asks the window manager to move window to space. If window was pinned, it will also result in window being visible only on space.

    Parameters

    Returns void

  • needsAttention(): boolean
  • Gets whether window needs attention. This state may change anytime a #WnckWindow::state-changed signal gets emitted.

    This state depends on flags such as the demands_attention and is_urgent hints.

    Returns boolean

  • notify(propertyName: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • orTransientNeedsAttention(): boolean
  • Gets whether window or one of its transients needs attention. This state may change anytime a #WnckWindow::state-changed signal gets emitted.

    Returns boolean

  • pin(): void
  • Asks the window manager to put window on all workspaces.

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • setData(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • setFullscreen(fullscreen: boolean): void
  • Asks the window manager to set the fullscreen state of window according to fullscreen.

    Parameters

    • fullscreen: boolean

      whether to make window fullscreen.

    Returns void

  • Sets the size and position of window. The X and Y coordinates should be relative to the root window.

    Note that the new size and position apply to window with its frame added by the window manager. Therefore, using wnck_window_set_geometry() with the values returned by wnck_window_get_geometry() should be a no-op, while using wnck_window_set_geometry() with the values returned by wnck_window_get_client_window_geometry() should reduce the size of window and move it.

    Parameters

    • gravity: WindowGravity

      the gravity point to use as a reference for the new position.

    • geometryMask: WindowMoveResizeMask

      a bitmask containing flags for what should be set.

    • x: number

      new X coordinate in pixels of window.

    • y: number

      new Y coordinate in pixels of window.

    • width: number

      new width in pixels of window.

    • height: number

      new height in pixels of window.

    Returns void

  • setIconGeometry(x: number, y: number, width: number, height: number): void
  • Sets the icon geometry for window. A typical use case for this is the destination of the minimization animation of window.

    Parameters

    • x: number

      X coordinate in pixels.

    • y: number

      Y coordinate in pixels.

    • width: number

      width in pixels.

    • height: number

      height in pixels.

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • setSkipPager(skip: boolean): void
  • Asks the window manager to make window included or not included on pagers.

    Parameters

    • skip: boolean

      whether window should be included on pagers.

    Returns void

  • setSkipTasklist(skip: boolean): void
  • Asks the window manager to make window included or not included on tasklists.

    Parameters

    • skip: boolean

      whether window should be included on tasklists.

    Returns void

  • setSortOrder(order: number): void
  • Sets the sort order of window. The sort order is used for ordering of window in #WnckSelector and #WnckTasklist.

    Parameters

    • order: number

      new sort order for window.

    Returns void

  • shade(): void
  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • stick(): void
  • Asks the window manager to keep the window<!-- -->'s position fixed on the screen, even when the workspace or viewport scrolls.

    Returns void

  • thawNotify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • transientIsMostRecentlyActivated(): boolean
  • Gets whether one of the transients of window is the most recently activated window. See wnck_window_is_most_recently_activated() for a more complete description of what is meant by most recently activated. This function is needed because clicking on a #WnckTasklist once will activate a transient instead of window itself (wnck_window_activate_transient), and clicking again should minimize window and its transients. (Not doing this can be especially annoying in the case of modal dialogs that don't appear in the #WnckTasklist).

    Returns boolean

  • unmakeAbove(): void
  • Asks the window manager to not put window on top of most windows, and to put it again in the stack with other windows.

    Returns void

  • unmakeBelow(): void
  • Asks the window manager to not put window below most windows, and to put it again in the stack with other windows.

    Returns void

  • unmaximize(): void
  • unmaximizeHorizontally(): void
  • Asks the window manager to unmaximize horizontally window.

    Returns void

  • unmaximizeVertically(): void
  • Asks the window manager to unmaximize vertically window.

    Returns void

  • unminimize(timestamp: number): void
  • Unminimizes window by activating it or one of its transients. See wnck_window_activate_transient() for details on how the activation is done.

    Parameters

    • timestamp: number

      the X server timestamp of the user interaction event that caused this call to occur.

    Returns void

  • unpin(): void
  • Asks the window manager to put window only in the currently active workspace, if window was previously pinned. If window was not pinned, does not change window<!-- -->'s workspace. If the active workspace is not known for some reason (it should not happen much), sets window<!-- -->'s workspace to the first workspace.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • unshade(): void
  • unstick(): void
  • Asks the window manager to not have window<!-- -->'s position fixed on the screen when the workspace or viewport scrolls.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • Gets a preexisting #WnckWindow for the X window xwindow. This will not create a #WnckWindow if none exists. The function is robust against bogus window IDs.

    Parameters

    • xwindow: number

      an X window ID.

    Returns Wnck.Window

  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method