Class: Handy::TabPage

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Instance Method Summary collapse

Instance Method Details

#child ⇒ Gtk::Widget

The child of the page.

Returns:

  • (Gtk::Widget) —

    child

#child=(child) ⇒ Gtk::Widget

The child of the page.

Parameters:

  • child (Gtk::Widget)

Returns:

  • (Gtk::Widget) —

    child

  • (Gtk::Widget) —

    child

#icon ⇒ Gio::Icon

The icon of the page.

[classTabBar] displays the icon next to the title.

It will not show the icon if [propertyTabPage:loading] is set to TRUE, or if the page is pinned and [propertyTabPage:indicator-icon] is set.

Returns:

  • (Gio::Icon) —

    icon

#icon=(icon) ⇒ Gio::Icon

The icon of the page.

[classTabBar] displays the icon next to the title.

It will not show the icon if [propertyTabPage:loading] is set to TRUE, or if the page is pinned and [propertyTabPage:indicator-icon] is set.

Parameters:

  • icon (Gio::Icon)

Returns:

  • (Gio::Icon) —

    icon

  • (Gio::Icon) —

    icon

#indicator_activatable ⇒ Boolean

Gets whether the indicator of self is activatable.

Returns:

  • (Boolean) —

    whether the indicator is activatable

#indicator_activatable=(indicator_activatable) ⇒ Boolean

Whether the indicator icon is activatable.

If set to TRUE, [signalTabView::indicator-activated] will be emitted when the indicator icon is clicked.

If [propertyTabPage:indicator-icon] is not set, does nothing.

Parameters:

  • indicator_activatable (Boolean)

Returns:

  • (Boolean) —

    indicator-activatable

  • (Boolean) —

    indicator-activatable

#indicator_activatable? ⇒ Boolean

Whether the indicator icon is activatable.

If set to TRUE, [signalTabView::indicator-activated] will be emitted when the indicator icon is clicked.

If [propertyTabPage:indicator-icon] is not set, does nothing.

Returns:

  • (Boolean) —

    indicator-activatable

#indicator_icon ⇒ Gio::Icon

An indicator icon for the page.

A common use case is an audio or camera indicator in a web browser.

[classTabPage] will show it at the beginning of the tab, alongside icon representing [propertyTabPage:icon] or loading spinner.

If the page is pinned, the indicator will be shown instead of icon or spinner.

If [propertyTabPage:indicator-activatable] is set to TRUE, the indicator icon can act as a button.

Returns:

  • (Gio::Icon) —

    indicator-icon

#indicator_icon=(indicator_icon) ⇒ Gio::Icon

An indicator icon for the page.

A common use case is an audio or camera indicator in a web browser.

[classTabPage] will show it at the beginning of the tab, alongside icon representing [propertyTabPage:icon] or loading spinner.

If the page is pinned, the indicator will be shown instead of icon or spinner.

If [propertyTabPage:indicator-activatable] is set to TRUE, the indicator icon can act as a button.

Parameters:

  • indicator_icon (Gio::Icon)

Returns:

  • (Gio::Icon) —

    indicator-icon

  • (Gio::Icon) —

    indicator-icon

#loading ⇒ Boolean

Gets whether self is loading.

Returns:

  • (Boolean) —

    whether self is loading

#loading=(loading) ⇒ Boolean

Whether the page is loading.

If set to TRUE, [classTabBar] will display a spinner in place of icon.

If the page is pinned and [propertyTabPage:indicator-icon] is set, the loading status will not be visible.

Parameters:

  • loading (Boolean)

Returns:

  • (Boolean) —

    loading

  • (Boolean) —

    loading

#loading? ⇒ Boolean

Whether the page is loading.

If set to TRUE, [classTabBar] will display a spinner in place of icon.

If the page is pinned and [propertyTabPage:indicator-icon] is set, the loading status will not be visible.

Returns:

  • (Boolean) —

    loading

#needs_attention ⇒ Boolean

Gets whether self needs attention.

Returns:

  • (Boolean) —

    whether self needs attention

#needs_attention=(needs_attention) ⇒ Boolean

Whether the page needs attention.

[classTabBar] will display a glow under the tab representing the page if set to TRUE. If the tab is not visible, the corresponding edge of the tab bar will be highlighted.

Parameters:

  • needs_attention (Boolean)

Returns:

  • (Boolean) —

    needs-attention

  • (Boolean) —

    needs-attention

#needs_attention? ⇒ Boolean

Whether the page needs attention.

[classTabBar] will display a glow under the tab representing the page if set to TRUE. If the tab is not visible, the corresponding edge of the tab bar will be highlighted.

Returns:

  • (Boolean) —

    needs-attention

#parent ⇒ Handy::TabPage

The parent page of the page.

See [methodTabView.add_page] and [methodTabView.close_page].

Returns:

#parent=(parent) ⇒ Handy::TabPage

The parent page of the page.

See [methodTabView.add_page] and [methodTabView.close_page].

Parameters:

Returns:

#pinned ⇒ Boolean

Gets whether self is pinned.

Returns:

  • (Boolean) —

    whether self is pinned

#pinned=(pinned) ⇒ Boolean

Whether the page is pinned.

See [methodTabView.set_page_pinned].

Parameters:

  • pinned (Boolean)

Returns:

  • (Boolean) —

    pinned

  • (Boolean) —

    pinned

#pinned? ⇒ Boolean

Whether the page is pinned.

See [methodTabView.set_page_pinned].

Returns:

  • (Boolean) —

    pinned

#selected ⇒ Boolean

Gets whether self is selected.

Returns:

  • (Boolean) —

    whether self is selected

#selected=(selected) ⇒ Boolean

Whether the page is selected.

Parameters:

  • selected (Boolean)

Returns:

  • (Boolean) —

    selected

  • (Boolean) —

    selected

#selected? ⇒ Boolean

Whether the page is selected.

Returns:

  • (Boolean) —

    selected

#title ⇒ String

The title of the page.

[classTabBar] will display it in the center of the tab unless it's pinned, and will use it as a tooltip unless [propertyTabPage:tooltip] is set.

Returns:

  • (String) —

    title

#title=(title) ⇒ String

The title of the page.

[classTabBar] will display it in the center of the tab unless it's pinned, and will use it as a tooltip unless [propertyTabPage:tooltip] is set.

Parameters:

  • title (String)

Returns:

  • (String) —

    title

  • (String) —

    title

#tooltip ⇒ String

The tooltip of the page.

The tooltip can be marked up with the Pango text markup language.

If not set, [classTabBar] will use [propertyTabPage:title] as a tooltip instead.

Returns:

  • (String) —

    tooltip

#tooltip=(tooltip) ⇒ String

The tooltip of the page.

The tooltip can be marked up with the Pango text markup language.

If not set, [classTabBar] will use [propertyTabPage:title] as a tooltip instead.

Parameters:

  • tooltip (String)

Returns:

  • (String) —

    tooltip

  • (String) —

    tooltip