gi-handy-1.0.4: libhandy bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Handy.Objects.TabPage

Description

An auxiliary class used by [classtabView].

Since: 1.2

Synopsis

Exported types

newtype TabPage Source #

Memory-managed wrapper type.

Constructors

TabPage (ManagedPtr TabPage) 

Instances

Instances details
Eq TabPage Source # 
Instance details

Defined in GI.Handy.Objects.TabPage

Methods

(==) :: TabPage -> TabPage -> Bool #

(/=) :: TabPage -> TabPage -> Bool #

GObject TabPage Source # 
Instance details

Defined in GI.Handy.Objects.TabPage

ManagedPtrNewtype TabPage Source # 
Instance details

Defined in GI.Handy.Objects.TabPage

Methods

toManagedPtr :: TabPage -> ManagedPtr TabPage

TypedObject TabPage Source # 
Instance details

Defined in GI.Handy.Objects.TabPage

Methods

glibType :: IO GType

HasParentTypes TabPage Source # 
Instance details

Defined in GI.Handy.Objects.TabPage

IsGValue (Maybe TabPage) Source #

Convert TabPage to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Handy.Objects.TabPage

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe TabPage -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe TabPage)

type ParentTypes TabPage Source # 
Instance details

Defined in GI.Handy.Objects.TabPage

type ParentTypes TabPage = '[Object]

class (GObject o, IsDescendantOf TabPage o) => IsTabPage o Source #

Type class for types which can be safely cast to TabPage, for instance with toTabPage.

Instances

Instances details
(GObject o, IsDescendantOf TabPage o) => IsTabPage o Source # 
Instance details

Defined in GI.Handy.Objects.TabPage

toTabPage :: (MonadIO m, IsTabPage o) => o -> m TabPage Source #

Cast to TabPage, for types for which this is known to be safe. For general casts, use castTo.

Methods

getChild

tabPageGetChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> m Widget

Returns: the child of self

Gets the child of self.

Since: 1.2

getIcon

tabPageGetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> m (Maybe Icon)

Returns: the icon of self

Gets the icon of self.

Since: 1.2

getIndicatorActivatable

tabPageGetIndicatorActivatable Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> m Bool

Returns: whether the indicator is activatable

Gets whether the indicator of self is activatable.

Since: 1.2

getIndicatorIcon

tabPageGetIndicatorIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> m (Maybe Icon)

Returns: the indicator icon of self

Gets the indicator icon of self.

Since: 1.2

getLoading

tabPageGetLoading Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> m Bool

Returns: whether self is loading

Gets whether self is loading.

Since: 1.2

getNeedsAttention

tabPageGetNeedsAttention Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> m Bool

Returns: whether self needs attention

Gets whether self needs attention.

Since: 1.2

getParent

tabPageGetParent Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> m (Maybe TabPage)

Returns: the parent page of self

Gets the parent page of self.

Since: 1.2

getPinned

tabPageGetPinned Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> m Bool

Returns: whether self is pinned

Gets whether self is pinned.

Since: 1.2

getSelected

tabPageGetSelected Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> m Bool

Returns: whether self is selected

Gets whether self is selected.

Since: 1.2

getTitle

tabPageGetTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> m (Maybe Text)

Returns: the title of self

Gets the title of self.

Since: 1.2

getTooltip

tabPageGetTooltip Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> m (Maybe Text)

Returns: the tooltip of self

Gets the tooltip of self.

Since: 1.2

setIcon

tabPageSetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a, IsIcon b) 
=> a

self: a tab page

-> Maybe b

icon: the icon of self

-> m () 

Sets the icon of self.

Since: 1.2

setIndicatorActivatable

tabPageSetIndicatorActivatable Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> Bool

activatable: whether the indicator is activatable

-> m () 

Sets whether the indicator of self is activatable.

Since: 1.2

setIndicatorIcon

tabPageSetIndicatorIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a, IsIcon b) 
=> a

self: a tab page

-> Maybe b

indicatorIcon: the indicator icon of self

-> m () 

Sets the indicator icon of self.

Since: 1.2

setLoading

tabPageSetLoading Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> Bool

loading: whether self is loading

-> m () 

Sets whether self is loading.

Since: 1.2

setNeedsAttention

tabPageSetNeedsAttention Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> Bool

needsAttention: whether self needs attention

-> m () 

Sets whether self needs attention.

Since: 1.2

setTitle

tabPageSetTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> Maybe Text

title: the title of self

-> m () 

Sets the title of self.

Since: 1.2

setTooltip

tabPageSetTooltip Source #

Arguments

:: (HasCallStack, MonadIO m, IsTabPage a) 
=> a

self: a tab page

-> Maybe Text

tooltip: the tooltip of self

-> m () 

Sets the tooltip of self.

Since: 1.2

Properties

child

The child of the page.

Since: 1.2

constructTabPageChild :: (IsTabPage o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “child” property. This is rarely needed directly, but it is used by new.

getTabPageChild :: (MonadIO m, IsTabPage o) => o -> m Widget Source #

Get the value of the “child” property. When overloading is enabled, this is equivalent to

get tabPage #child

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.

Since: 1.2

clearTabPageIcon :: (MonadIO m, IsTabPage o) => o -> m () Source #

Set the value of the “icon” property to Nothing. When overloading is enabled, this is equivalent to

clear #icon

constructTabPageIcon :: (IsTabPage o, MonadIO m, IsIcon a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “icon” property. This is rarely needed directly, but it is used by new.

getTabPageIcon :: (MonadIO m, IsTabPage o) => o -> m (Maybe Icon) Source #

Get the value of the “icon” property. When overloading is enabled, this is equivalent to

get tabPage #icon

setTabPageIcon :: (MonadIO m, IsTabPage o, IsIcon a) => o -> a -> m () Source #

Set the value of the “icon” property. When overloading is enabled, this is equivalent to

set tabPage [ #icon := value ]

indicatorActivatable

Whether the indicator icon is activatable.

If set to TRUE, signaltabView[indicatorActivated] will be emitted when the indicator icon is clicked.

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

Since: 1.2

constructTabPageIndicatorActivatable :: (IsTabPage o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “indicator-activatable” property. This is rarely needed directly, but it is used by new.

getTabPageIndicatorActivatable :: (MonadIO m, IsTabPage o) => o -> m Bool Source #

Get the value of the “indicator-activatable” property. When overloading is enabled, this is equivalent to

get tabPage #indicatorActivatable

setTabPageIndicatorActivatable :: (MonadIO m, IsTabPage o) => o -> Bool -> m () Source #

Set the value of the “indicator-activatable” property. When overloading is enabled, this is equivalent to

set tabPage [ #indicatorActivatable := value ]

indicatorIcon

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.

Since: 1.2

clearTabPageIndicatorIcon :: (MonadIO m, IsTabPage o) => o -> m () Source #

Set the value of the “indicator-icon” property to Nothing. When overloading is enabled, this is equivalent to

clear #indicatorIcon

constructTabPageIndicatorIcon :: (IsTabPage o, MonadIO m, IsIcon a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “indicator-icon” property. This is rarely needed directly, but it is used by new.

getTabPageIndicatorIcon :: (MonadIO m, IsTabPage o) => o -> m (Maybe Icon) Source #

Get the value of the “indicator-icon” property. When overloading is enabled, this is equivalent to

get tabPage #indicatorIcon

setTabPageIndicatorIcon :: (MonadIO m, IsTabPage o, IsIcon a) => o -> a -> m () Source #

Set the value of the “indicator-icon” property. When overloading is enabled, this is equivalent to

set tabPage [ #indicatorIcon := value ]

loading

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.

Since: 1.2

constructTabPageLoading :: (IsTabPage o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “loading” property. This is rarely needed directly, but it is used by new.

getTabPageLoading :: (MonadIO m, IsTabPage o) => o -> m Bool Source #

Get the value of the “loading” property. When overloading is enabled, this is equivalent to

get tabPage #loading

setTabPageLoading :: (MonadIO m, IsTabPage o) => o -> Bool -> m () Source #

Set the value of the “loading” property. When overloading is enabled, this is equivalent to

set tabPage [ #loading := value ]

needsAttention

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.

Since: 1.2

constructTabPageNeedsAttention :: (IsTabPage o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “needs-attention” property. This is rarely needed directly, but it is used by new.

getTabPageNeedsAttention :: (MonadIO m, IsTabPage o) => o -> m Bool Source #

Get the value of the “needs-attention” property. When overloading is enabled, this is equivalent to

get tabPage #needsAttention

setTabPageNeedsAttention :: (MonadIO m, IsTabPage o) => o -> Bool -> m () Source #

Set the value of the “needs-attention” property. When overloading is enabled, this is equivalent to

set tabPage [ #needsAttention := value ]

parent

The parent page of the page.

See [methodtabView.add_page] and [methodtabView.close_page].

Since: 1.2

constructTabPageParent :: (IsTabPage o, MonadIO m, IsTabPage a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “parent” property. This is rarely needed directly, but it is used by new.

getTabPageParent :: (MonadIO m, IsTabPage o) => o -> m (Maybe TabPage) Source #

Get the value of the “parent” property. When overloading is enabled, this is equivalent to

get tabPage #parent

pinned

Whether the page is pinned.

See [methodtabView.set_page_pinned].

Since: 1.2

getTabPagePinned :: (MonadIO m, IsTabPage o) => o -> m Bool Source #

Get the value of the “pinned” property. When overloading is enabled, this is equivalent to

get tabPage #pinned

selected

Whether the page is selected.

Since: 1.2

getTabPageSelected :: (MonadIO m, IsTabPage o) => o -> m Bool Source #

Get the value of the “selected” property. When overloading is enabled, this is equivalent to

get tabPage #selected

title

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.

Since: 1.2

clearTabPageTitle :: (MonadIO m, IsTabPage o) => o -> m () Source #

Set the value of the “title” property to Nothing. When overloading is enabled, this is equivalent to

clear #title

constructTabPageTitle :: (IsTabPage o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “title” property. This is rarely needed directly, but it is used by new.

getTabPageTitle :: (MonadIO m, IsTabPage o) => o -> m (Maybe Text) Source #

Get the value of the “title” property. When overloading is enabled, this is equivalent to

get tabPage #title

setTabPageTitle :: (MonadIO m, IsTabPage o) => o -> Text -> m () Source #

Set the value of the “title” property. When overloading is enabled, this is equivalent to

set tabPage [ #title := value ]

tooltip

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.

Since: 1.2

clearTabPageTooltip :: (MonadIO m, IsTabPage o) => o -> m () Source #

Set the value of the “tooltip” property to Nothing. When overloading is enabled, this is equivalent to

clear #tooltip

constructTabPageTooltip :: (IsTabPage o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “tooltip” property. This is rarely needed directly, but it is used by new.

getTabPageTooltip :: (MonadIO m, IsTabPage o) => o -> m (Maybe Text) Source #

Get the value of the “tooltip” property. When overloading is enabled, this is equivalent to

get tabPage #tooltip

setTabPageTooltip :: (MonadIO m, IsTabPage o) => o -> Text -> m () Source #

Set the value of the “tooltip” property. When overloading is enabled, this is equivalent to

set tabPage [ #tooltip := value ]