class Adw::TabPage

Overview

An auxiliary class used by #TabView.

Defined in:

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

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class GObject::Object

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)? data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, 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)? qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void)?) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void)? steal_data, steal_qdata(quark : UInt32) : Pointer(Void)? 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, 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

compat_control(what : UInt64, data : Pointer(Void)?) : 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

Constructor Detail

def self.new #

Initialize a new TabPage.


def self.new(*, child : Gtk::Widget? = nil, icon : Gio::Icon? = nil, indicator_activatable : Bool? = nil, indicator_icon : Gio::Icon? = nil, indicator_tooltip : String? = nil, loading : Bool? = nil, needs_attention : Bool? = nil, parent : Adw::TabPage? = nil, pinned : Bool? = nil, selected : Bool? = nil, title : String? = nil, tooltip : String? = nil) #

Class Method Detail

def self.g_type : UInt64 #

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


Instance Method Detail

def child : Gtk::Widget #

Gets the child of @self.


def child=(value : Gtk::Widget?) : Gtk::Widget? #

def icon : Gio::Icon? #

Gets the icon of @self.


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

Sets the icon of @self.

#TabBar displays the icon next to the title.

It will not show the icon if TabPage::loading is set to TRUE, or 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? #

Gets the indicator icon of @self.


def indicator_icon=(indicator_icon : Gio::Icon?) : 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.

[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 loading : Bool #

Gets whether @self is loading.


def loading=(loading : Bool) : Nil #

Sets whether @self is loading.

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

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


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.


def needs_attention? : Bool #

def parent : Adw::TabPage? #

Gets the parent page of @self.

See TabView::add_page and TabView::close_page.


def parent=(value : Adw::TabPage?) : Adw::TabPage? #

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 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.

Sets the title of @self.


def tooltip : String? #

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 will use TabPage::title as a tooltip instead.