Class

AdwNavigationPage

since: 1.4

Description [src] 

class Adw.NavigationPage : Gtk.Widget
  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
  /* No available fields */
}

A page within AdwNavigationView or AdwNavigationSplitView.

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

The AdwNavigationPage::showing, AdwNavigationPage::shown, AdwNavigationPage::hiding and AdwNavigationPage::hidden signals can be used to track the page’s visibility within its AdwNavigationView.

Header Bar Integration

When placed inside AdwNavigationPage, AdwHeaderBar will display the page title instead of window title.

When used together with AdwNavigationView, it will also display a back button that can be used to go back to the previous page. Set AdwHeaderBar: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.

Available since: 1.4

Hierarchy

hierarchy this AdwNavigationPage implements_0 GtkAccessible this--implements_0 implements_1 GtkBuildable this--implements_1 implements_2 GtkConstraintTarget this--implements_2 ancestor_0 GtkWidget ancestor_0--this ancestor_1 GInitiallyUnowned ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

Ancestors

Implements

Constructors

adw_navigation_page_new

Creates a new AdwNavigationPage.

since: 1.4

adw_navigation_page_new_with_tag

Creates a new AdwNavigationPage with provided tag.

since: 1.4

Instance methods

adw_navigation_page_get_can_pop

Gets whether self can be popped from navigation stack.

since: 1.4

adw_navigation_page_get_child

Gets the child widget of self.

since: 1.4

adw_navigation_page_get_tag

Gets the tag of self.

since: 1.4

adw_navigation_page_get_title

Gets the title of self.

since: 1.4

adw_navigation_page_set_can_pop

Sets whether self can be popped from navigation stack.

since: 1.4

adw_navigation_page_set_child

Sets the child widget of self.

since: 1.4

adw_navigation_page_set_tag

Sets the tag for self.

since: 1.4

adw_navigation_page_set_title

Sets the title of self.

since: 1.4

Methods inherited from GtkWidget (164)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkAccessible (20)
gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

gtk_accessible_get_at_context

Retrieves the implementation for the given accessible object.

gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

gtk_accessible_get_platform_state

Queries a platform state, such as focus.

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling.

gtk_accessible_update_platform_state

Informs ATs that the platform state has changed.

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Properties

Adw.NavigationPage:can-pop

Whether the page can be popped from navigation stack.

since: 1.4

Adw.NavigationPage:child

The child widget.

since: 1.4

Adw.NavigationPage:tag

The page tag.

since: 1.4

Adw.NavigationPage:title

The page title.

since: 1.4

Properties inherited from GtkWidget (35)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the GtkWidget::query-tooltip signal on widget.

Gtk.Widget:height-request

Overrides for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:limit-events

Makes this widget act like a modal dialog, with respect to event delivery.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Overrides for width request of the widget.

Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Signals

Adw.NavigationPage::hidden

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

since: 1.4

Adw.NavigationPage::hiding

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

since: 1.4

Adw.NavigationPage::showing

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

since: 1.4

Adw.NavigationPage::shown

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

since: 1.4

Signals inherited from GtkWidget (13)
GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

GtkWidget::hide

Emitted when widget is hidden.

GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

GtkWidget::map

Emitted when widget is going to be mapped.

GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

GtkWidget::move-focus

Emitted when the focus is moved.

GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

GtkWidget::realize

Emitted when widget is associated with a GdkSurface.

GtkWidget::show

Emitted when widget is shown.

GtkWidget::state-flags-changed

Emitted when the widget state changes.

GtkWidget::unmap

Emitted when widget is going to be unmapped.

GtkWidget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure 

struct AdwNavigationPageClass {
  GtkWidgetClass parent_class;
  void (* showing) (
    AdwNavigationPage* self
  );
  void (* shown) (
    AdwNavigationPage* self
  );
  void (* hiding) (
    AdwNavigationPage* self
  );
  void (* hidden) (
    AdwNavigationPage* self
  );
  
}

No description available.

Class members
parent_class: GtkWidgetClass

No description available.

showing: void (* showing) ( AdwNavigationPage* self )

No description available.

shown: void (* shown) ( AdwNavigationPage* self )

No description available.

hiding: void (* hiding) ( AdwNavigationPage* self )

No description available.

hidden: void (* hidden) ( AdwNavigationPage* self )

No description available.

Virtual methods

Adw.NavigationPageClass.hidden

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

since: 1.4

Adw.NavigationPageClass.hiding

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

since: 1.4

Adw.NavigationPageClass.showing

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

since: 1.4

Adw.NavigationPageClass.shown

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

since: 1.4