Devhelp.Sidebar¶

Subclasses:: None

Methods¶

Inherited:: Gtk.Grid (21), 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` (book_manager)
class	`new2` (profile)
	`get_profile` ()
	`get_selected_link` ()
	`select_uri` (uri)
	`set_search_focus` ()
	`set_search_string` (str)

Virtual Methods¶

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

do_link_selected (link)

Properties¶

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

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

Child Properties¶

Inherited:: Gtk.Grid (4)

Style Properties¶

Inherited:: Gtk.Widget (17)

Signals¶

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

Name	Short Description
`link-selected`	The `::link-selected` signal is emitted when: One row in one of the `Gtk.TreeView`'s is selected and contains a `Devhelp.Link` (i.e.

Fields¶

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

Name	Type	Access	Description
parent_instance	`Gtk.Grid`	r

Class Details¶

class Devhelp.Sidebar(**kwargs)¶

Bases:: Gtk.Grid
Abstract:: No
Structure:: Devhelp.SidebarClass

classmethod new(book_manager)¶

Parameters:: book_manager (Devhelp.BookManager or None) – a Devhelp.BookManager. This parameter is deprecated, you should just pass None.
Returns:: a new Devhelp.Sidebar widget.
Return type:: Gtk.Widget

Deprecated since version 3.30: Use Devhelp.Sidebar.new2() instead.

classmethod new2(profile)¶

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

New in version 3.30.

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 the visible Gtk.TreeView of 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

Note: the return value of this function is not necessarily the same as the last Devhelp.Link emitted by the Devhelp.Sidebar ::link-selected signal. See the documentation of Devhelp.Sidebar ::link-selected.

New in version 3.30.

select_uri(uri)¶

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

Calls Devhelp.BookTree.select_uri().

set_search_focus()¶: Gives the focus to the search entry.

set_search_string(str)¶

Parameters:: str (str) – the string to search.

do_link_selected(link) virtual¶

Parameters:: link (Devhelp.Link) –

Signal Details¶

Devhelp.Sidebar.signals.link_selected(sidebar, link)¶

Signal Name:

link-selected

Flags:

RUN_LAST

Parameters:

sidebar (Devhelp.Sidebar) – The object which received the signal
link (Devhelp.Link) – the selected Devhelp.Link.

The ::link-selected signal is emitted when:

One row in one of the Gtk.TreeView's is selected and contains a Devhelp.Link (i.e. when the row is not a language group);

Or if there is an exact match returned by Devhelp.KeywordModel.filter() when a search occurs.

Note that Devhelp.Sidebar.get_selected_link() takes into account only the former, not the latter. So the last link emitted with this signal is not necessarily the same as the current return value of Devhelp.Sidebar.get_selected_link().

Property Details¶

Devhelp.Sidebar.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.