Devhelp.BookTree¶

Subclasses:: None

Methods¶

Inherited:: Gtk.TreeView (98), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.Scrollable (9)
Structs:: Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`new` (profile)
	`get_profile` ()
	`get_selected_link` ()
	`select_uri` (uri)

Virtual Methods¶

Inherited:: Gtk.TreeView (15), Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10), Gtk.Scrollable (1)

Properties¶

Inherited:: Gtk.TreeView (18), Gtk.Container (3), Gtk.Widget (39), Gtk.Scrollable (4)

Name	Type	Flags	Short Description
`profile`	`Devhelp.Profile`	r/w/co

Style Properties¶

Inherited:: Gtk.TreeView (11), Gtk.Widget (17)

Signals¶

Inherited:: Gtk.TreeView (15), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Short Description
`link-selected`

Fields¶

Inherited:: Gtk.TreeView (15), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Gtk.TreeView`	r

Class Details¶

class Devhelp.BookTree(*args, **kwargs)¶

Bases:: Gtk.TreeView
Abstract:: No
Structure:: Devhelp.BookTreeClass

classmethod new(profile)¶

Parameters:: profile (Devhelp.Profile or None) – a Devhelp.Profile, or None for the default profile.
Returns:: a new Devhelp.BookTree widget.
Return type:: Devhelp.BookTree

get_profile()¶

Returns:: the Devhelp.Profile of self.
Return type:: Devhelp.Profile

New in version 3.30.

get_selected_link()¶

Returns:: the currently selected Devhelp.Link in self, or None if the selection is empty or if a language group row is selected. Unref with Devhelp.Link.unref() when no longer needed.
Return type:: Devhelp.Link or None

New in version 3.30.

select_uri(uri)¶

Parameters:: uri (str) – the URI to select.

Selects the row corresponding to uri. It searches in the tree a Devhelp.Link being at uri (if it’s an exact match), or containing uri (if uri contains an anchor).

Signal Details¶

Devhelp.BookTree.signals.link_selected(book_tree, link)¶

Signal Name:

link-selected

Flags:

RUN_LAST

Parameters:

book_tree (Devhelp.BookTree) – The object which received the signal
link (Devhelp.Link) – the selected Devhelp.Link.

Property Details¶

Devhelp.BookTree.props.profile¶

Name:: profile
Type:: Devhelp.Profile
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The Devhelp.Profile. If set to None, the default profile as returned by Devhelp.Profile.get_default() is used.

New in version 3.30.