GimpUi.Dialog

g Atk.ImplementorIface Atk.ImplementorIface Gtk.Widget Gtk.Widget Atk.ImplementorIface->Gtk.Widget GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Gtk.Widget GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned GimpUi.Dialog GimpUi.Dialog Gtk.Bin Gtk.Bin Gtk.Window Gtk.Window Gtk.Bin->Gtk.Window Gtk.Buildable->Gtk.Widget Gtk.Container Gtk.Container Gtk.Container->Gtk.Bin Gtk.Dialog Gtk.Dialog Gtk.Dialog->GimpUi.Dialog Gtk.Widget->Gtk.Container Gtk.Window->Gtk.Dialog

Subclasses:

GimpUi.ProcBrowserDialog, GimpUi.ProcedureDialog

Methods

Inherited:

Gtk.Dialog (14), Gtk.Window (119), Gtk.Bin (1), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10)

Structs:

Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

add_button (button_text, response_id)

get_native_handle ()

run ()

set_alternative_button_order_from_array (order)

Virtual Methods

Inherited:

Gtk.Dialog (2), Gtk.Window (5), Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10)

Properties

Inherited:

Gtk.Dialog (1), Gtk.Window (33), Gtk.Container (3), Gtk.Widget (39)

Name

Type

Flags

Short Description

help-func

int

r/w/co

The help function to call when F1 is hit

help-id

str

r/w/c

The help ID to pass to help-func

Style Properties

Inherited:

Gtk.Dialog (4), Gtk.Window (2), Gtk.Widget (17)

Signals

Inherited:

Gtk.Dialog (2), Gtk.Window (5), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Fields

Inherited:

Gtk.Dialog (2), Gtk.Window (5), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name

Type

Access

Description

parent_instance

Gtk.Dialog

r

Class Details

class GimpUi.Dialog(*args, **kwargs)
Bases:

Gtk.Dialog

Abstract:

No

Structure:

GimpUi.DialogClass

Constructors for Gtk.Dialog's and action_areas as well as other dialog-related stuff.

add_button(button_text, response_id)
Parameters:
  • button_text (str) – text of button, or stock ID.

  • response_id (int) – response ID for the button.

Returns:

the button widget that was added.

Return type:

Gtk.Widget

This function is essentially the same as Gtk.Dialog.add_button() except it ensures there is only one help button and automatically sets the RESPONSE_OK widget as the default response.

get_native_handle()
Returns:

an opaque [struct`GLib`.Bytes] identifying this window.

Return type:

GLib.Bytes

Returns an opaque data handle representing the window in the currently running platform. You should not try to use this directly. Usually this is to be used in functions such as [func`Gimp`.brushes_popup] which will allow the core process to set this [class`Dialog`] as parent to the newly created popup.

New in version 3.0.

run()
Returns:

response ID

Return type:

int

This function does exactly the same as Gtk.Dialog.run() except it does not make the dialog modal while the GLib.MainLoop is running.

set_alternative_button_order_from_array(order)
Parameters:

order ([int]) – array of buttons’ response ids.

Reorder self's buttons if [property`Gtk`.Settings:gtk-alternative-button-order] is set to True. This is mostly a wrapper around the GTK function [method`Gtk`.Dialog.set_alternative_button_order], except it won’t output a deprecation warning.

New in version 3.0.

Property Details

GimpUi.Dialog.props.help_func
Name:

help-func

Type:

int

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The help function to call when F1 is hit

New in version 2.2.

GimpUi.Dialog.props.help_id
Name:

help-id

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

The help ID to pass to help-func

New in version 2.2.