Endless.PageManager¶

Subclasses:: None

Methods¶

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

class	`new` ()
	`get_page_background_position` (page)
	`get_page_background_repeats` (page)
	`get_page_background_size` (page)
	`get_page_background_uri` (page)
	`get_page_center_topbar_widget` (page)
	`get_page_left_topbar_widget` (page)
	`remove_page_by_name` (name)
	`set_page_background_position` (page, position)
	`set_page_background_repeats` (page, repeats)
	`set_page_background_size` (page, size)
	`set_page_background_uri` (page, background)
	`set_page_center_topbar_widget` (page, center_topbar_widget)
	`set_page_left_topbar_widget` (page, left_topbar_widget)

Virtual Methods¶

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

Properties¶

Inherited:: Gtk.Stack (9), Gtk.Container (3), Gtk.Widget (39)

Child Properties¶

Inherited:: Gtk.Stack (5)

Name	Type	Default	Flags	Short Description
`background-position`	`str`	`'0% 0%'`	r/w	Position of background of the page
`background-repeats`	`bool`	`True`	r/w	If page background repeats
`background-size`	`str`	`'100% 100%'`	r/w	Size of background of the page
`background-uri`	`str`	`None`	r/w	URI for background of the page
`center-topbar-widget`	`Gtk.Widget`	`None`	r/w	Center topbar widget displayed in the middle of the topbar
`left-topbar-widget`	`Gtk.Widget`	`None`	r/w	Left topbar widget displayed left of the topbar

Style Properties¶

Inherited:: Gtk.Widget (17)

Signals¶

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

Fields¶

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

Name	Type	Access	Description
parent	`Gtk.Stack`	r

Class Details¶

class Endless.PageManager(**kwargs)¶

Bases:: Gtk.Stack
Abstract:: No
Structure:: Endless.PageManagerClass

This structure contains no public members.

classmethod new()¶

Returns:: the new page manager.
Return type:: Gtk.Widget

Creates a new default page manager.

get_page_background_position(page)¶

Parameters:: page (Gtk.Widget) – the page to be queried
Returns:: the position of page, as an EosSizePercentage.
Return type:: str

Gets the position of the background image of page, which must previously have been added to the page manager. See Endless.PageManager :background-position for more information.

get_page_background_repeats(page)¶

Parameters:: page (Gtk.Widget) – the page to be queried
Returns:: True if the background of page will repeat.
Return type:: bool

Gets whether or not the background image of page will tile when drawn. page must previously have been added to the page manager. See Endless.PageManager :background-repeats for more information.

get_page_background_size(page)¶

Parameters:: page (Gtk.Widget) – the page to be queried
Returns:: the size of page, as an EosSizePercentage.
Return type:: str

Gets the size of the background image of page, which must previously have been added to the page manager. See Endless.PageManager :background-size for more information.

get_page_background_uri(page)¶

Parameters:: page (Gtk.Widget) – the page to be queried
Returns:: the background of page, or the None if page does not have a background.
Return type:: str

Gets the URI for the background image of page, which must previously have been added to the page manager. See Endless.PageManager :background-uri for more information.

get_page_center_topbar_widget(page)¶

Parameters:: page (Gtk.Widget) – the page to be queried
Returns:: the center topbar Gtk.Widget of page, or None if there is none.
Return type:: Gtk.Widget

Retrieves page's center topbar widget, if it has one. See Endless.PageManager :center-topbar-widget for more information.

get_page_left_topbar_widget(page)¶

Parameters:: page (Gtk.Widget) – the page to be queried
Returns:: the left topbar Gtk.Widget of page, or None if there is none.
Return type:: Gtk.Widget

Retrieves page's left topbar widget, if it has one. See Endless.PageManager :left-topbar-widget for more information.

remove_page_by_name(name)¶

Parameters:: name (str) – the name of the page to remove

Removes the page called name from the page manager. If that page was the only page, then the page manager will display nothing. If that page was currently displaying but was not the only page, then the page manager will display another page; which page is undefined.

To remove a page without looking it up by name, use Gtk.Container.remove().

set_page_background_position(page, position)¶

Parameters:

page (Gtk.Widget) – the page to be modified
position (str) – the desired position of the background image of this page.

Changes the position of the background of page, which must previously have been added to the page manager. See Endless.PageManager :background-position for more information.

set_page_background_repeats(page, repeats)¶

Parameters:

page (Gtk.Widget) – the page to be modified
repeats (bool) – True if the background of page will repeat.

Sets whether or not the background image of page will tile when drawn. page must previously have been added to the page manager. See Endless.PageManager :background-repeats for more information.

set_page_background_size(page, size)¶

Parameters:

page (Gtk.Widget) – the page to be modified
size (str) – the desired size of the background image of this page.

Changes the size of the background of page, which must previously have been added to the page manager. See Endless.PageManager :background-size for more information.

set_page_background_uri(page, background)¶

Parameters:

page (Gtk.Widget) – the page to be modified
background (str or None) – the URI for the background image of this page.

Changes the background of page, which must previously have been added to the page manager. Setting None removes the background, using the window’s default background. See Endless.PageManager :background-uri for more information.

set_page_center_topbar_widget(page, center_topbar_widget)¶

Parameters:

page (Gtk.Widget) – the page
center_topbar_widget (Gtk.Widget or None) – center topbar widget for page

Sets the center topbar widget to be displayed for this page. See Endless.PageManager :center-topbar-widget for more information.

set_page_left_topbar_widget(page, left_topbar_widget)¶

Parameters:

page (Gtk.Widget) – the page
left_topbar_widget (Gtk.Widget or None) – left topbar widget for page

Sets the left topbar widget to be displayed for this page. See Endless.PageManager :left-topbar-widget for more information.