adwaita/org.gtkkn.bindings.adw/NavigationPage

NavigationPage

open class NavigationPage(pointer: <Error class: unknown class><<Error class: unknown class>>)

A page within class@NavigationView or class@NavigationSplitView.

Each page has a child widget, a title and optionally a tag.

The signal@NavigationPage::showing, signal@NavigationPage::shown, signal@NavigationPage::hiding and signal@NavigationPage::hidden signals can be used to track the page's visibility within its AdwNavigationView.

Header Bar Integration

When placed inside AdwNavigationPage, class@HeaderBar will display the page title instead of window title.

When used together with class@NavigationView, it will also display a back button that can be used to go back to the previous page. Set property@HeaderBar:show-back-button to FALSE to disable that behavior if it's unwanted.

CSS Nodes

AdwNavigationPage has a single CSS node with name navigation-view-page.

Accessibility

AdwNavigationPage uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Since

1.4

Constructors

NavigationPage

constructor(child: <Error class: unknown class>, title: String)

Creates a new AdwNavigationPage.

constructor(child: <Error class: unknown class>, title: String, tag: String)

Creates a new AdwNavigationPage with provided tag.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

adwNavigationPagePointer

val adwNavigationPagePointer: <Error class: unknown class><<Error class: unknown class>>

canPop

open var canPop: Boolean

Whether the page can be popped from navigation stack.

child

open var child: <Error class: unknown class>?

The child widget.

gtkAccessiblePointer

open val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkConstraintTargetPointer

open val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>

tag

open var tag: String?

The page tag.

title

open var title: String

The page title.

Functions

connectHidden

fun connectHidden(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when the navigation view transition has been completed and the page is fully hidden.

connectHiding

fun connectHiding(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when the page starts hiding at the beginning of the navigation view transition.

connectShowing

fun connectShowing(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when the page shows at the beginning of the navigation view transition.

connectShown

fun connectShown(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when the navigation view transition has been completed and the page is fully shown.

getCanPop

open fun getCanPop(): Boolean

Gets whether @self can be popped from navigation stack.

getChild

open fun getChild(): <Error class: unknown class>?

Gets the child widget of @self.

getTag

open fun getTag(): String?

Gets the tag of @self.

getTitle

open fun getTitle(): String

Gets the title of @self.

setCanPop

open fun setCanPop(canPop: Boolean)

Sets whether @self can be popped from navigation stack.

setChild

open fun setChild(child: <Error class: unknown class>? = null)

Sets the child widget of @self.

setTag

open fun setTag(tag: String? = null)

Sets the tag for @self.

setTitle

open fun setTitle(title: String)

Sets the title of @self.