class Adw::TabPage

Overview

An auxiliary class used by #TabView.

Included Modules

Defined in:

lib/gi-crystal/src/auto/adw-1/tab_page.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Gtk::Accessible

accessible_parent : Gtk::Accessible | Nil accessible_parent, accessible_role : Gtk::AccessibleRole accessible_role, accessible_role=(value : Gtk::AccessibleRole) : Gtk::AccessibleRole accessible_role=, announce(message : String, priority : Gtk::AccessibleAnnouncementPriority) : Nil announce, at_context : Gtk::ATContext at_context, bounds(x : Int32, y : Int32, width : Int32, height : Int32) : Bool bounds, first_accessible_child : Gtk::Accessible | Nil first_accessible_child, next_accessible_sibling : Gtk::Accessible | Nil next_accessible_sibling, platform_state(state : Gtk::AccessiblePlatformState) : Bool platform_state, reset_property(property : Gtk::AccessibleProperty) : Nil reset_property, reset_relation(relation : Gtk::AccessibleRelation) : Nil reset_relation, reset_state(state : Gtk::AccessibleState) : Nil reset_state, set_accessible_parent(parent : Gtk::Accessible | Nil, next_sibling : Gtk::Accessible | Nil) : Nil set_accessible_parent, to_unsafe to_unsafe, update_next_accessible_sibling(new_sibling : Gtk::Accessible | Nil) : Nil update_next_accessible_sibling, update_platform_state(state : Gtk::AccessiblePlatformState) : Nil update_platform_state, update_property(properties : Enumerable(Gtk::AccessibleProperty), values : Enumerable(_)) : Nil update_property, update_relation(relations : Enumerable(Gtk::AccessibleRelation), values : Enumerable(_)) : Nil update_relation, update_state(states : Enumerable(Gtk::AccessibleState), values : Enumerable(_)) : Nil update_state

Constructor methods inherited from module Gtk::Accessible

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::Accessible

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new #

Initialize a new TabPage.


def self.new(*, accessible_role : Gtk::AccessibleRole | Nil = nil, child : Gtk::Widget | Nil = nil, icon : Gio::Icon | Nil = nil, indicator_activatable : Bool | Nil = nil, indicator_icon : Gio::Icon | Nil = nil, indicator_tooltip : String | Nil = nil, keyword : String | Nil = nil, live_thumbnail : Bool | Nil = nil, loading : Bool | Nil = nil, needs_attention : Bool | Nil = nil, parent : Adw::TabPage | Nil = nil, pinned : Bool | Nil = nil, selected : Bool | Nil = nil, thumbnail_xalign : Float32 | Nil = nil, thumbnail_yalign : Float32 | Nil = nil, title : String | Nil = nil, tooltip : String | Nil = nil) #

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def child : Gtk::Widget #

Gets the child of self.


def child=(value : Gtk::Widget | Nil) : Gtk::Widget | Nil #

def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def icon : Gio::Icon | Nil #

Gets the icon of self.


def icon=(icon : Gio::Icon | Nil) : Nil #

Sets the icon of self.

#TabBar and #TabOverview display the icon next to the title, unless TabPage::loading is set to TRUE.

Adw::TabBar also won't show the icon if the page is pinned and [propertyTabPage:indicator-icon] is set.


def indicator_activatable : Bool #

Gets whether the indicator of self is activatable.


def indicator_activatable=(activatable : Bool) : Nil #

Sets whether the indicator of self is activatable.

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

If [property@TabPage:indicator-icon] is not set, does nothing.


def indicator_activatable? : Bool #

def indicator_icon : Gio::Icon | Nil #

Gets the indicator icon of self.


def indicator_icon=(indicator_icon : Gio::Icon | Nil) : Nil #

Sets the indicator icon of self.

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

#TabBar will show it at the beginning of the tab, alongside icon representing TabPage::icon or loading spinner.

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

#TabOverview will show it at the at the top part of the thumbnail.

[property@TabPage:indicator-tooltip] can be used to set the tooltip on the indicator icon.

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


def indicator_tooltip : String #

Gets the tooltip of the indicator icon of self.


def indicator_tooltip=(tooltip : String) : Nil #

Sets the tooltip of the indicator icon of self.

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

See [property@TabPage:indicator-icon].


def indicator_tooltip=(value : Nil) : Nil #

Set #indicator_tooltip property to nil.


def indicator_tooltip? : String | Nil #

Same as #indicator_tooltip, but can return nil.


def invalidate_thumbnail : Nil #

Invalidates thumbnail for self.

If an #TabOverview is open, the thumbnail representing self will be immediately updated. Otherwise it will be update when opening the overview.

Does nothing if [property@TabPage:live-thumbnail] is set to TRUE.

See also TabView::invalidate_thumbnails.


def keyword : String | Nil #

Gets the search keyword of self.


def keyword=(keyword : String) : Nil #

Sets the search keyword for self.

#TabOverview can search pages by their keywords in addition to their titles and tooltips.

Keywords allow to include e.g. page URLs into tab search in a web browser.


def keyword=(value : Nil) : Nil #

Set #keyword property to nil.


def keyword? : String | Nil #

Same as #keyword, but can return nil.


def live_thumbnail : Bool #

Gets whether to live thumbnail is enabled self.


def live_thumbnail=(live_thumbnail : Bool) : Nil #

Sets whether to enable live thumbnail for self.

When set to TRUE, self's thumbnail in #TabOverview will update immediately when self is redrawn or resized.

If it's set to FALSE, the thumbnail will only be live when the self is selected, and otherwise it will be static and will only update when TabPage::invalidate_thumbnail or TabView::invalidate_thumbnails is called.


def live_thumbnail? : Bool #

def loading : Bool #

Gets whether self is loading.


def loading=(loading : Bool) : Nil #

Sets whether self is loading.

If set to TRUE, #TabBar and #TabOverview will display a spinner in place of icon.

If the page is pinned and [property@TabPage:indicator-icon] is set, loading status will not be visible with Adw::TabBar.


def loading? : Bool #

def needs_attention : Bool #

Gets whether self needs attention.


def needs_attention=(needs_attention : Bool) : Nil #

Sets whether self needs attention.

#TabBar will display a line 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.

#TabOverview will display a dot in the corner of the thumbnail if set to TRUE.

#TabButton will display a dot if any of the pages that aren't selected have [property@TabPage:needs-attention] set to TRUE.


def needs_attention? : Bool #

def parent : Adw::TabPage | Nil #

Gets the parent page of self.

See TabView::add_page and TabView::close_page.


def parent=(value : Adw::TabPage | Nil) : Adw::TabPage | Nil #

def pinned : Bool #

Gets whether self is pinned.

See TabView#page_pinned=.


def pinned? : Bool #

def selected : Bool #

Gets whether self is selected.


def selected? : Bool #

def thumbnail_xalign : Float32 #

Gets the horizontal alignment of the thumbnail for self.


def thumbnail_xalign=(xalign : Float32) : Nil #

Sets the horizontal alignment of the thumbnail for self.

If the page is so wide that #TabOverview can't display it completely and has to crop it, horizontal alignment will determine which part of the page will be visible.

For example, 0.5 means the center of the page will be visible, 0 means the start edge will be visible and 1 means the end edge will be visible.

The default horizontal alignment is 0.


def thumbnail_yalign : Float32 #

Gets the vertical alignment of the thumbnail for self.


def thumbnail_yalign=(yalign : Float32) : Nil #

Sets the vertical alignment of the thumbnail for self.

If the page is so tall that #TabOverview can't display it completely and has to crop it, vertical alignment will determine which part of the page will be visible.

For example, 0.5 means the center of the page will be visible, 0 means the top edge will be visible and 1 means the bottom edge will be visible.

The default vertical alignment is 0.


def title : String #

Gets the title of self.


def title=(title : String) : Nil #

#TabBar will display it in the center of the tab unless it's pinned, and will use it as a tooltip unless TabPage::tooltip is set.

#TabOverview will display it below the thumbnail unless it's pinned, or inside the card otherwise, and will use it as a tooltip unless TabPage::tooltip is set.

Sets the title of self.


def title=(value : Nil) : Nil #

Set #title property to nil.


def title? : String | Nil #

Same as #title, but can return nil.


def tooltip : String | Nil #

Gets the tooltip of self.


def tooltip=(tooltip : String) : Nil #

Sets the tooltip of self.

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

If not set, #TabBar and #TabOverview will use TabPage::title as a tooltip instead.


def tooltip=(value : Nil) : Nil #

Set #tooltip property to nil.


def tooltip? : String | Nil #

Same as #tooltip, but can return nil.