Gtk.StackPage

Subclasses:

None

Methods

Inherited:

GObject.Object (37), Gtk.Accessible (15)

Structs:

GObject.ObjectClass (5)

	get_child ()
	get_icon_name ()
	get_name ()
	get_needs_attention ()
	get_title ()
	get_use_underline ()
	get_visible ()
	set_icon_name (setting)
	set_name (setting)
	set_needs_attention (setting)
	set_title (setting)
	set_use_underline (setting)
	set_visible (visible)

Virtual Methods

Inherited:

GObject.Object (7), Gtk.Accessible (6)

Properties

Inherited:

Gtk.Accessible (1)

Name	Type	Flags	Short Description
child	Gtk.Widget	r/w/co
icon-name	str	r/w
name	str	r/w
needs-attention	bool	r/w/en
title	str	r/w
use-underline	bool	r/w/en
visible	bool	r/w/en

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Gtk.StackPage(**kwargs)

Bases:

GObject.Object, Gtk.Accessible

Abstract:

No

GtkStackPage is an auxiliary class used by GtkStack.

get_child()

Returns:

the child to which self belongs

Return type:

Gtk.Widget

Returns the stack child to which self belongs.

get_icon_name()

Returns:

The value of the [property`Gtk`.StackPage:icon-name] property

Return type:

str or None

Returns the icon name of the page.

get_name()

Returns:

The value of the [property`Gtk`.StackPage:name] property

Return type:

str or None

Returns the name of the page.

get_needs_attention()

Returns:

The value of the [property`Gtk`.StackPage:needs-attention] property.

Return type:

bool

Returns whether the page is marked as “needs attention”.

get_title()

Returns:

The value of the [property`Gtk`.StackPage:title] property

Return type:

str or None

Gets the page title.

get_use_underline()

Returns:

The value of the [property`Gtk`.StackPage:use-underline] property

Return type:

bool

Gets whether underlines in the page title indicate mnemonics.

get_visible()

Returns:

True if page is visible

Return type:

bool

Returns whether page is visible in its GtkStack.

This is independent from the [property`Gtk`.Widget:visible] property of its widget.

set_icon_name(setting)

Parameters:

setting (str) – the new value to set

Sets the icon name of the page.

set_name(setting)

Parameters:

setting (str) – the new value to set

Sets the name of the page.

set_needs_attention(setting)

Parameters:

setting (bool) – the new value to set

Sets whether the page is marked as “needs attention”.

set_title(setting)

Parameters:

setting (str) – the new value to set

Sets the page title.

set_use_underline(setting)

Parameters:

setting (bool) – the new value to set

Sets whether underlines in the page title indicate mnemonics.

set_visible(visible)

Parameters:

visible (bool) – The new property value

Sets whether page is visible in its GtkStack.

Property Details

Gtk.StackPage.props.child

Name:

child

Type:

Gtk.Widget

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The child that this page is for.

Gtk.StackPage.props.icon_name

Name:

icon-name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The icon name of the child page.

Gtk.StackPage.props.name

Name:

name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The name of the child page.

Gtk.StackPage.props.needs_attention

Name:

needs-attention

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the page requires the user attention.

This is used by the [class`Gtk`.StackSwitcher] to change the appearance of the corresponding button when a page needs attention and it is not the current one.

Gtk.StackPage.props.title

Name:

title

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The title of the child page.

Gtk.StackPage.props.use_underline

Name:

use-underline

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

If set, an underline in the title indicates a mnemonic.

Gtk.StackPage.props.visible

Name:

visible

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether this page is visible.