GimpUi.Browser¶

Subclasses:: None

Methods¶

Inherited:: Gtk.Paned (12), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.Orientable (2)
Structs:: Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`new` ()
	`get_left_vbox` ()
	`get_right_vbox` ()
	`set_search_summary` (summary)
	`set_widget` (widget)
	`show_message` (message)

Virtual Methods¶

Inherited:: Gtk.Paned (6), Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10)

Properties¶

Inherited:: Gtk.Paned (5), Gtk.Container (3), Gtk.Widget (39), Gtk.Orientable (1)

Child Properties¶

Inherited:: Gtk.Paned (2)

Style Properties¶

Inherited:: Gtk.Paned (1), Gtk.Widget (17)

Signals¶

Inherited:: Gtk.Paned (6), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Short Description
`search`
`stop-search`	This signal is emitted when the search operation was stopped by user input.

Fields¶

Inherited:: Gtk.Paned (6), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Class Details¶

class GimpUi.Browser(**kwargs)¶

Bases:: Gtk.Paned
Abstract:: No
Structure:: GimpUi.BrowserClass

A base class for a documentation browser.

classmethod new()¶

Returns:: a newly created GimpUi.Browser.
Return type:: Gtk.Widget

Create a new GimpUi.Browser widget.

New in version 2.4.

get_left_vbox()¶

Returns:: The left vbox.
Return type:: Gtk.Box

New in version 3.0.

get_right_vbox()¶

Returns:: The right vbox.
Return type:: Gtk.Box

New in version 3.0.

set_search_summary(summary)¶

Parameters:: summary (str) – a string describing the search result

Sets the search summary text.

New in version 3.0.

set_widget(widget)¶

Parameters:: widget (Gtk.Widget) – a Gtk.Widget

Sets the widget to appear on the right side of the self.

New in version 2.4.

show_message(message)¶

Parameters:: message (str) – text message

Displays message in the right side of the self. Unless the right side already contains a Gtk.Label, the widget previously added with GimpUi.Browser.set_widget() is removed and replaced by a Gtk.Label.

New in version 2.4.

Signal Details¶

GimpUi.Browser.signals.search(browser, object, p0)¶

Signal Name:

search

Flags:

RUN_LAST

Parameters:

browser (GimpUi.Browser) – The object which received the signal
object (str) –
p0 (int) –

GimpUi.Browser.signals.stop_search(browser)¶

Signal Name:: stop-search
Flags:: RUN_LAST
Parameters:: browser (GimpUi.Browser) – The object which received the signal

This signal is emitted when the search operation was stopped by user input.