Libxfce4ui.TitledDialog

Subclasses:

None

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)

class	new ()
	add_action_widget (child, response_id)
	add_button (button_text, response_id)
	create_action_area ()
	get_subtitle ()
	set_default_response (response_id)
	set_subtitle (subtitle)

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
subtitle	str	r/w	subtitle

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)

Class Details

class Libxfce4ui.TitledDialog(*args, **kwargs)

Bases:

Gtk.Dialog

Abstract:

No

Structure:

Libxfce4ui.TitledDialogClass

An opaque struct with only private fields.

classmethod new()

Returns:

the newly allocated Libxfce4ui.TitledDialog.

Return type:

Gtk.Widget

Allocates a new Libxfce4ui.TitledDialog instance.

add_action_widget(child, response_id)

Parameters:

• child (Gtk.Widget) – an activatable widget.

• response_id (int) – response ID for child.

This function is a replacement for Gtk.Dialog.add_action_widget and assumes that you have called Libxfce4ui.TitledDialog.create_action_area before.

Children with Gtk.ResponseType.HELP will be added to the secondary group of children (see Gtk.ButtonBox.set_child_secondary for reference).

New in version 4.16.

add_button(button_text, response_id)

Parameters:

• button_text (str) – text of button.

• response_id (int) – response ID for child.

Returns:

the Gtk.Button widget that was added.

Return type:

Gtk.Widget

This function is a replacement for Gtk.Dialog.add_button and assumes that you have called Libxfce4ui.TitledDialog.create_action_area before.

Buttons with Gtk.ResponseType.HELP will be added to the secondary group of children (see Gtk.ButtonBox.set_child_secondary for reference).

New in version 4.16.

create_action_area()

This function creates a custom action area (of type Gtk.ButtonBox) and has to be used in combination with Libxfce4ui.TitledDialog.add_action_widget.

When using the Libxfce4ui.TitledDialogClass directly to create dialogs this function is useful to keep action widgets out of the Gtk.HeaderBar in which they would normally end up by calling Gtk.Dialog.add_action_widget.

New in version 4.16.

get_subtitle()

Returns:

the subtitle of self, or None.

Return type:

str

Returns the subtitle of the self, or None if no subtitle is displayed in the self. This is just a convenience function around Gtk.HeaderBar.get_subtitle.

set_default_response(response_id)

Parameters:

response_id (int) – a response ID

Sets the last widget in the dialog’s action area with the given response_id as the default widget for the dialog. Pressing “Enter” normally activates the default widget.

This function is a replacement for Gtk.Dialog.set_default_response, which does not work with Libxfce4ui.TitledDialog.

New in version 4.16.

set_subtitle(subtitle)

Parameters:

subtitle (str or None) – the new subtitle for the self, or None.

Sets the subtitle displayed by self to subtitle; if subtitle is None no subtitle will be displayed by the self. This is just a convenience function around Gtk.HeaderBar.set_subtitle when dialogs use header bars. Otherwise a simple label and separator are shown at the top of dialog.

Property Details

Libxfce4ui.TitledDialog.props.subtitle

Name:

subtitle

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The subtitle displayed below the main dialog title.