Hdy.TabView – libhandy-1 – Vala Binding Reference

Description:

[ CCode ( type_id = "hdy_tab_view_get_type ()" ) ]
[ Version ( since = "1.2" ) ]
public class TabView : Bin, Implementor, Buildable

A dynamic tabbed container.

`HdyTabView` is a container which shows one child at a time. While it provides keyboard shortcuts for switching between pages, it does not provide a visible tab bar and relies on external widgets for that, such as [class@TabBar].

`HdyTabView` maintains a [class@TabPage] object for each page,which holds additional per-page properties. You can obtain the [ class@TabPage] for a page with [method@TabView.get_page], and as return value for [method@TabView.append] and other functions for adding children.

`HdyTabView` only aims to be useful for dynamic tabs in multi-window document-based applications, such as web browsers, file managers, text editors or terminals. It does not aim to replace [class@Gtk.Notebook] for use cases such as tabbed dialogs.

As such, it does not support disabling page reordering or detaching, or adding children via [iface@Gtk.Buildable].

CSS nodes

`HdyTabView` has a main CSS node with the name `tabview`.

It contains the subnode overlay, which contains subnodes stack and widget. The stack subnode contains the added pages.

``` tabview ╰── overlay ├── stack │ ╰── [ Children ] ╰── widget ```

Namespace: Hdy

Content:

Properties:

public Icon default_icon { get; set; }

Default page icon.

public bool is_transferring_page { get; }

Whether a page is being transferred.

public MenuModel menu_model { get; set; }

Tab context menu model.

public int n_pages { get; }

The number of pages in the tab view.

public int n_pinned_pages { get; }

The number of pinned pages in the tab view.

public TabPage selected_page { get; set; }

The currently selected page.

public Widget shortcut_widget { get; set; }

Tab shortcut widget.

Creation methods:

public TabView ()

Creates a new `HdyTabView`.

Methods:

public unowned TabPage add_page (Widget child, TabPage? parent)

Adds child to this with parent as the parent.

public unowned TabPage append (Widget child)

Inserts child as the last non-pinned page.

public unowned TabPage append_pinned (Widget child)

Inserts child as the last pinned page.

public void close_other_pages (TabPage page)

Requests to close all pages other than page.

public void close_page_finish (TabPage page, bool confirm)

Completes a [method@TabView.

public void close_pages_after (TabPage page)

Requests to close all pages after page.

public void close_pages_before (TabPage page)

Requests to close all pages before page.

public unowned Icon get_default_icon ()

Gets default icon of this.

public bool get_is_transferring_page ()

Whether a page is being transferred.

public unowned MenuModel? get_menu_model ()

Gets the tab context menu model for this .

public int get_n_pages ()

Gets the number of pages in this.

public int get_n_pinned_pages ()

Gets the number of pinned pages in this .

public unowned TabPage get_nth_page (int position)

Gets the [class@TabPage] representing the child at

position

public unowned TabPage get_page (Widget child)

Gets the [class@TabPage] object representing child.

public int get_page_position (TabPage page)

Finds the position of page in this, starting from 0.

public unowned ListModel get_pages ()

Returns a [iface@Gio.

public unowned TabPage? get_selected_page ()

Gets the currently selected page in this .

public unowned Widget? get_shortcut_widget ()

Gets the shortcut widget for this.

public unowned TabPage insert (Widget child, int position)

Inserts a non-pinned page at position.

public unowned TabPage insert_pinned (Widget child, int position)

Inserts a pinned page at position.

public unowned TabPage prepend (Widget child)

Inserts child as the first non-pinned page.

public unowned TabPage prepend_pinned (Widget child)

Inserts child as the first pinned page.

public bool reorder_backward (TabPage page)

Reorders page to before its previous page if possible.

public bool reorder_first (TabPage page)

Reorders page to the first possible position.

public bool reorder_forward (TabPage page)

Reorders page to after its next page if possible.

public bool reorder_last (TabPage page)

Reorders page to the last possible position.

public bool reorder_page (TabPage page, int position)

Reorders page to position.

public bool select_next_page ()

Selects the page after the currently selected page.

public bool select_previous_page ()

Selects the page before the currently selected page.

public void set_default_icon (Icon default_icon)

Sets default page icon for this.

public void set_menu_model (MenuModel? menu_model)

Sets the tab context menu model for this .

public void set_page_pinned (TabPage page, bool pinned)

Pins or unpins page.

public void set_selected_page (TabPage selected_page)

Sets the currently selected page in this .

public void set_shortcut_widget (Widget? widget)

Sets the shortcut widget for this.

public void transfer_page (TabPage page, TabView other_view, int position)

Transfers page from this to other_view.

Signals:

public signal bool close_page (TabPage page)

Emitted after [method@TabView.

public signal unowned TabView? create_window ()

Emitted when a tab should be transferred into a new window.

public signal void indicator_activated (TabPage page)

Emitted after the indicator icon on page has been activated.

public signal void page_attached (TabPage page, int position)

Emitted when a page has been created or transferred to the view.

public signal void page_detached (TabPage page, int position)

Emitted when a page has been removed or transferred to another view.

public signal void page_reordered (TabPage page, int position)

This signal is emitted after page has been reordered to position.

public signal void setup_menu (TabPage page)

Emitted when a context menu is opened or closed for page.

Inherited Members:

All known members inherited from class Gtk.Bin

get_child

All known members inherited from interface Atk.Implementor

ref_accessible

TabView

Object Hierarchy: