Gjsify LogoGjsify Logo

A GdkPopup is a surface that is attached to another surface.

The GdkPopup is positioned relative to its parent surface.

GdkPopups are typically used to implement menus and similar popups. They can be modal, which is indicated by the [propertyGdkPopup:autohide] property.

interface

Hierarchy

Index

Constructors

Properties

autohide: boolean

Whether to hide on outside clicks.

cursor: Gdk.Cursor

The mouse pointer for the GdkSurface.

display: Gdk.Display

The GdkDisplay connection of the surface.

frame_clock: Gdk.FrameClock

The GdkFrameClock of the surface.

g_type_instance: TypeInstance
height: number

The height of the surface, in pixels.

mapped: boolean

Whether the surface is mapped.

parent: Gdk.Surface

The parent surface.

scale_factor: number

The scale factor of the surface.

width: number

The width of the surface in pixels.

$gtype: GType<Popup>
name: string

Methods

  • beep(): void
  • Emits a short beep associated to surface.

    If the display of surface does not support per-surface beeps, emits a short beep on the display just as [methodGdk.Display.beep].

    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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: 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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

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

    • transform_from: TClosure<any, any>

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

    Returns Binding

  • connect(sigName: "notify::autohide", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::parent", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::cursor", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::display", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::frame-clock", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::height", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::mapped", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::scale-factor", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::width", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: "notify::autohide", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::parent", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::cursor", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::display", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::frame-clock", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::height", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::mapped", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::scale-factor", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::width", callback: (($obj: Popup, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • Creates a new GdkGLContext for the GdkSurface.

    The context is disconnected from any particular surface or surface. If the creation of the GdkGLContext failed, error will be set. Before using the returned GdkGLContext, you will need to call [methodGdk.GLContext.make_current] or [methodGdk.GLContext.realize].

    Returns Gdk.GLContext

  • Create a new Cairo surface that is as compatible as possible with the given surface.

    For example the new surface will have the same fallback resolution and font options as surface. Generally, the new surface will also use the same backend as surface, unless that is not possible for some reason. The type of the returned surface may be examined with cairo_surface_get_type().

    Initially the surface contents are all 0 (transparent if contents have transparency, black otherwise.)

    This function always returns a valid pointer, but it will return a pointer to a “nil” surface if other is already in an error state or any other error occurs.

    Parameters

    • content: cairo.Content

      the content for the new surface

    • width: number

      width of the new surface

    • height: number

      height of the new surface

    Returns cairo.Surface

  • destroy(): void
  • Destroys the window system resources associated with surface and decrements surface's reference count.

    The window system resources for all children of surface are also destroyed, but the children’s reference counts are not decremented.

    Note that a surface will not be destroyed automatically when its reference count reaches zero. You must call this function yourself before that happens.

    Returns void

  • disconnect(id: number): void
  • emit(sigName: "notify::autohide", ...args: any[]): void
  • emit(sigName: "notify::parent", ...args: any[]): void
  • emit(sigName: "notify::cursor", ...args: any[]): void
  • emit(sigName: "notify::display", ...args: any[]): void
  • emit(sigName: "notify::frame-clock", ...args: any[]): void
  • emit(sigName: "notify::height", ...args: any[]): void
  • emit(sigName: "notify::mapped", ...args: any[]): void
  • emit(sigName: "notify::scale-factor", ...args: any[]): void
  • emit(sigName: "notify::width", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • force_floating(): 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

  • freeze_notify(): 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

  • get_autohide(): boolean
  • Retrieves a GdkCursor pointer for the cursor currently set on the GdkSurface.

    If the return value is %NULL then there is no custom cursor set on the surface, and it is using the cursor for its parent surface.

    Use [methodGdk.Surface.set_cursor] to unset the cursor of the surface.

    Returns Gdk.Cursor

  • get_data(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

  • Retrieves a GdkCursor pointer for the device currently set on the specified GdkSurface.

    If the return value is %NULL then there is no custom cursor set on the specified surface, and it is using the cursor for its parent surface.

    Use [methodGdk.Surface.set_cursor] to unset the cursor of the surface.

    Parameters

    Returns Gdk.Cursor

  • get_height(): number
  • Returns the height of the given surface.

    Surface size is reported in ”application pixels”, not ”device pixels” (see [methodGdk.Surface.get_scale_factor]).

    Returns number

  • get_mapped(): boolean
  • get_position_x(): number
  • get_position_y(): number
  • get_property(property_name?: 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 property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • Gets the current popup rectangle anchor.

    The value returned may change after calling [methodGdk.Popup.present], or after the [signalGdk.Surface::layout] signal is emitted.

    Returns Gdk.Gravity

  • get_scale_factor(): number
  • Returns the internal scale factor that maps from surface coordinates to the actual device pixels.

    On traditional systems this is 1, but on very high density outputs this can be a higher value (often 2). A higher value means that drawing is automatically scaled up to a higher resolution, so any code doing drawing will automatically look nicer. However, if you are supplying pixel-based data the scale value can be used to determine whether to use a pixel resource with higher resolution data.

    The scale of a surface may change during runtime.

    Returns number

  • Gets the current popup surface anchor.

    The value returned may change after calling [methodGdk.Popup.present], or after the [signalGdk.Surface::layout] signal is emitted.

    Returns Gdk.Gravity

  • get_width(): number
  • Returns the width of the given surface.

    Surface size is reported in ”application pixels”, not ”device pixels” (see [methodGdk.Surface.get_scale_factor]).

    Returns 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

  • hide(): void
  • Hide the surface.

    For toplevel surfaces, withdraws them, so they will no longer be known to the window manager; for all surfaces, unmaps them, so they won’t be displayed. Normally done automatically as part of [methodGtk.Widget.hide].

    Returns void

  • is_destroyed(): boolean
  • is_floating(): boolean
  • notify(property_name: 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

    • property_name: 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

  • present(width: number, height: number, layout: PopupLayout): boolean
  • Present popup after having processed the GdkPopupLayout rules.

    If the popup was previously now showing, it will be showed, otherwise it will change position according to layout.

    After calling this function, the result should be handled in response to the [signalGdkSurface::layout] signal being emitted. The resulting popup position can be queried using [methodGdk.Popup.get_position_x], [methodGdk.Popup.get_position_y], and the resulting size will be sent as parameters in the layout signal. Use [methodGdk.Popup.get_rect_anchor] and [methodGdk.Popup.get_surface_anchor] to get the resulting anchors.

    Presenting may fail, for example if the popup is set to autohide and is immediately hidden upon being presented. If presenting failed, the [signalGdk.Surface::layout] signal will not me emitted.

    Parameters

    • width: number

      the unconstrained popup width to layout

    • height: number

      the unconstrained popup height to layout

    • layout: PopupLayout

      the GdkPopupLayout object used to layout

    Returns boolean

  • queue_render(): void
  • Forces a [signalGdk.Surface::render] signal emission for surface to be scheduled.

    This function is useful for implementations that track invalid regions on their own.

    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

  • request_layout(): void
  • run_dispose(): 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

  • Sets the default mouse pointer for a GdkSurface.

    Passing %NULL for the cursor argument means that surface will use the cursor of its parent surface. Most surfaces should use this default. Note that cursor must be for the same display as surface.

    Use [ctorGdk.Cursor.new_from_name] or [ctorGdk.Cursor.new_from_texture] to create the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR.

    Parameters

    Returns void

  • set_data(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

  • Sets a specific GdkCursor for a given device when it gets inside surface.

    Passing %NULL for the cursor argument means that surface will use the cursor of its parent surface. Most surfaces should use this default.

    Use [ctorGdk.Cursor.new_from_name] or [ctorGdk.Cursor.new_from_texture] to create the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR.

    Parameters

    Returns void

  • Apply the region to the surface for the purpose of event handling.

    Mouse events which happen while the pointer position corresponds to an unset bit in the mask will be passed on the surface below surface.

    An input region is typically used with RGBA surfaces. The alpha channel of the surface defines which pixels are invisible and allows for nicely antialiased borders, and the input region controls where the surface is “clickable”.

    Use [methodGdk.Display.supports_input_shapes] to find out if a particular backend supports input regions.

    Parameters

    Returns void

  • Marks a region of the GdkSurface as opaque.

    For optimisation purposes, compositing window managers may like to not draw obscured regions of surfaces, or turn off blending during for these regions. With RGB windows with no transparency, this is just the shape of the window, but with ARGB32 windows, the compositor does not know what regions of the window are transparent or not.

    This function only works for toplevel surfaces.

    GTK will update this property automatically if the surface background is opaque, as we know where the opaque regions are. If your surface background is not opaque, please update this property in your [vfuncGtk.Widget.css_changed] handler.

    Parameters

    • region: cairo.Region

      a region, or %NULL to make the entire surface opaque

    Returns void

  • set_property(property_name: string, value?: any): void
  • steal_data(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

  • steal_qdata(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

  • thaw_notify(): 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

  • translate_coordinates(to: Gdk.Surface, x: number, y: number): [boolean, number, number]
  • Translates coordinates between two surfaces.

    Note that this only works if to and from are popups or transient-for to the same toplevel (directly or indirectly).

    Parameters

    • to: Gdk.Surface

      the target surface

    • x: number

      coordinates to translate

    • y: number

      coordinates to translate

    Returns [boolean, number, number]

  • 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

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): 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.

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • watch_closure(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

  • compat_control(what: number, data: object): number
  • 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

    • g_iface: TypeInterface

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

    • property_name: 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

    • g_iface: 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

    • g_iface: 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

    • object_type: 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