RB.DisplayPageTree¶

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` (shell)
	`edit_source_name` (source)
	`select` (page)
	`toggle_expanded` (page)

Virtual Methods¶

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

	`do_drop_received` (page, data)
	`do_selected` (page)

Properties¶

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

Name	Type	Flags	Short Description
`model`	`Gtk.TreeModel`	r	`Gtk.TreeModel` object
`shell`	`RB.Shell`	r/w/co	`RB.Shell` object

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
`drop-received`	Emitted when a drag and drop to the tree completes.
`selected`	Emitted when a page is selected from the tree

Fields¶

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

Name	Type	Access	Description
parent	`Gtk.Grid`	r

Class Details¶

class RB.DisplayPageTree(**kwargs)¶

Bases:: Gtk.Grid
Abstract:: No
Structure:: RB.DisplayPageTreeClass

The display page tree widget is a Gtk.TreeView backed by a Gtk.ListStore containing the display page instances (sources and other things). xlib.Display pages include sources, such as the library and playlists, and other things like the visualization display.

xlib.Display pages are shown in the list with an icon and the name. The current playing source is displayed in bold.

Sources are divided into groups - library, stores, playlists, devices, network shares. Groups are displayed as headers, with expanders for hiding and showing the sources in the group. Sources themselves may also have child sources, such as playlists on portable audio players.

classmethod new(shell)¶

Parameters:: shell (RB.Shell) – the RB.Shell instance
Returns:: the display page tree widget.
Return type:: RB.DisplayPageTree

Creates the display page tree widget.

edit_source_name(source)¶

Parameters:: source (RB.Source) – the RB.Source to edit

Initiates editing of the name of the specified source. The row for the source is selected and given input focus, allowing the user to edit the name. source_name_edited_cb is called when the user finishes editing.

select(page)¶

Parameters:: page (RB.DisplayPage) – the RB.DisplayPage to select

Selects the specified page in the tree. This will result in the ‘selected’ signal being emitted.

toggle_expanded(page)¶

Parameters:: page (RB.DisplayPage) – the RB.DisplayPage to toggle

If page is expanded (children visible), collapses it, otherwise expands it.

do_drop_received(page, data) virtual¶

Parameters:

page (RB.DisplayPage) –
data (Gtk.SelectionData) –

do_selected(page) virtual¶

Parameters:: page (RB.DisplayPage) –

Signal Details¶

RB.DisplayPageTree.signals.drop_received(display_page_tree, page, data)¶

Signal Name:

drop-received

Flags:

RUN_LAST

Parameters:

display_page_tree (RB.DisplayPageTree) – The object which received the signal
page (object or None) – the #RBDisplagePage receiving the drop
data (object or None) – the drop data

Emitted when a drag and drop to the tree completes.

RB.DisplayPageTree.signals.selected(display_page_tree, page)¶

Signal Name:

selected

Flags:

RUN_LAST

Parameters:

display_page_tree (RB.DisplayPageTree) – The object which received the signal
page (GObject.Object) – the newly selected RB.DisplayPage

Emitted when a page is selected from the tree

Property Details¶

RB.DisplayPageTree.props.model¶

Name:: model
Type:: Gtk.TreeModel
Default Value:: None
Flags:: READABLE

The Gtk.TreeModel for the display page tree

RB.DisplayPageTree.props.shell¶

Name:: shell
Type:: RB.Shell
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The RB.Shell instance