Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype TabPage = TabPage (ManagedPtr TabPage)
- class (GObject o, IsDescendantOf TabPage o) => IsTabPage o
- toTabPage :: (MonadIO m, IsTabPage o) => o -> m TabPage
- tabPageGetChild :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m Widget
- tabPageGetIcon :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m (Maybe Icon)
- tabPageGetIndicatorActivatable :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m Bool
- tabPageGetIndicatorIcon :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m (Maybe Icon)
- tabPageGetLoading :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m Bool
- tabPageGetNeedsAttention :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m Bool
- tabPageGetParent :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m (Maybe TabPage)
- tabPageGetPinned :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m Bool
- tabPageGetSelected :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m Bool
- tabPageGetTitle :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m (Maybe Text)
- tabPageGetTooltip :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m (Maybe Text)
- tabPageSetIcon :: (HasCallStack, MonadIO m, IsTabPage a, IsIcon b) => a -> Maybe b -> m ()
- tabPageSetIndicatorActivatable :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Bool -> m ()
- tabPageSetIndicatorIcon :: (HasCallStack, MonadIO m, IsTabPage a, IsIcon b) => a -> Maybe b -> m ()
- tabPageSetLoading :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Bool -> m ()
- tabPageSetNeedsAttention :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Bool -> m ()
- tabPageSetTitle :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Maybe Text -> m ()
- tabPageSetTooltip :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Maybe Text -> m ()
- constructTabPageChild :: (IsTabPage o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getTabPageChild :: (MonadIO m, IsTabPage o) => o -> m Widget
- clearTabPageIcon :: (MonadIO m, IsTabPage o) => o -> m ()
- constructTabPageIcon :: (IsTabPage o, MonadIO m, IsIcon a) => a -> m (GValueConstruct o)
- getTabPageIcon :: (MonadIO m, IsTabPage o) => o -> m (Maybe Icon)
- setTabPageIcon :: (MonadIO m, IsTabPage o, IsIcon a) => o -> a -> m ()
- constructTabPageIndicatorActivatable :: (IsTabPage o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTabPageIndicatorActivatable :: (MonadIO m, IsTabPage o) => o -> m Bool
- setTabPageIndicatorActivatable :: (MonadIO m, IsTabPage o) => o -> Bool -> m ()
- clearTabPageIndicatorIcon :: (MonadIO m, IsTabPage o) => o -> m ()
- constructTabPageIndicatorIcon :: (IsTabPage o, MonadIO m, IsIcon a) => a -> m (GValueConstruct o)
- getTabPageIndicatorIcon :: (MonadIO m, IsTabPage o) => o -> m (Maybe Icon)
- setTabPageIndicatorIcon :: (MonadIO m, IsTabPage o, IsIcon a) => o -> a -> m ()
- constructTabPageLoading :: (IsTabPage o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTabPageLoading :: (MonadIO m, IsTabPage o) => o -> m Bool
- setTabPageLoading :: (MonadIO m, IsTabPage o) => o -> Bool -> m ()
- constructTabPageNeedsAttention :: (IsTabPage o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTabPageNeedsAttention :: (MonadIO m, IsTabPage o) => o -> m Bool
- setTabPageNeedsAttention :: (MonadIO m, IsTabPage o) => o -> Bool -> m ()
- constructTabPageParent :: (IsTabPage o, MonadIO m, IsTabPage a) => a -> m (GValueConstruct o)
- getTabPageParent :: (MonadIO m, IsTabPage o) => o -> m (Maybe TabPage)
- getTabPagePinned :: (MonadIO m, IsTabPage o) => o -> m Bool
- getTabPageSelected :: (MonadIO m, IsTabPage o) => o -> m Bool
- clearTabPageTitle :: (MonadIO m, IsTabPage o) => o -> m ()
- constructTabPageTitle :: (IsTabPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getTabPageTitle :: (MonadIO m, IsTabPage o) => o -> m (Maybe Text)
- setTabPageTitle :: (MonadIO m, IsTabPage o) => o -> Text -> m ()
- clearTabPageTooltip :: (MonadIO m, IsTabPage o) => o -> m ()
- constructTabPageTooltip :: (IsTabPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getTabPageTooltip :: (MonadIO m, IsTabPage o) => o -> m (Maybe Text)
- setTabPageTooltip :: (MonadIO m, IsTabPage o) => o -> Text -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq TabPage Source # | |
GObject TabPage Source # | |
Defined in GI.Handy.Objects.TabPage | |
ManagedPtrNewtype TabPage Source # | |
Defined in GI.Handy.Objects.TabPage toManagedPtr :: TabPage -> ManagedPtr TabPage # | |
TypedObject TabPage Source # | |
Defined in GI.Handy.Objects.TabPage | |
HasParentTypes TabPage Source # | |
Defined in GI.Handy.Objects.TabPage | |
IsGValue (Maybe TabPage) Source # | Convert |
Defined in GI.Handy.Objects.TabPage | |
type ParentTypes TabPage Source # | |
Defined in GI.Handy.Objects.TabPage |
class (GObject o, IsDescendantOf TabPage o) => IsTabPage o Source #
Instances
(GObject o, IsDescendantOf TabPage o) => IsTabPage o Source # | |
Defined in GI.Handy.Objects.TabPage |
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getChild, getData, getIcon, getIndicatorActivatable, getIndicatorIcon, getLoading, getNeedsAttention, getParent, getPinned, getProperty, getQdata, getSelected, getTitle, getTooltip.
Setters
setData, setDataFull, setIcon, setIndicatorActivatable, setIndicatorIcon, setLoading, setNeedsAttention, setProperty, setTitle, setTooltip.
getChild
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Widget | Returns: the child of |
Gets the child of self
.
Since: 1.2
getIcon
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m (Maybe Icon) | Returns: the icon of |
Gets the icon of self
, see tabPageSetIcon
.
Since: 1.2
getIndicatorActivatable
tabPageGetIndicatorActivatable Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Bool | Returns: whether the indicator is activatable |
Gets whether the indicator of self
is activatable, see
tabPageSetIndicatorActivatable
.
Since: 1.2
getIndicatorIcon
tabPageGetIndicatorIcon Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m (Maybe Icon) | Returns: the indicator icon of |
Gets the indicator icon of self
, see tabPageSetIndicatorIcon
.
Since: 1.2
getLoading
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Bool | Returns: whether |
Gets whether self
is loading, see tabPageSetLoading
.
Since: 1.2
getNeedsAttention
tabPageGetNeedsAttention Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Bool | Returns: whether |
Gets whether self
needs attention, see tabPageSetNeedsAttention
.
Since: 1.2
getParent
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m (Maybe TabPage) | Returns: the parent page of |
Gets the parent page of self
, or Nothing
if the self
does not have a parent.
See tabViewAddPage
and tabViewClosePage
.
Since: 1.2
getPinned
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Bool | Returns: whether |
Gets whether self
is pinned. See tabViewSetPagePinned
.
Since: 1.2
getSelected
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Bool | Returns: whether |
Gets whether self
is selected. See tabViewSetSelectedPage
.
Since: 1.2
getTitle
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m (Maybe Text) | Returns: the title of |
Gets the title of self
, see tabPageSetTitle
.
Since: 1.2
getTooltip
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m (Maybe Text) | Returns: the tooltip of |
Gets the tooltip of self
, see tabPageSetTooltip
.
Since: 1.2
setIcon
setIndicatorActivatable
tabPageSetIndicatorActivatable Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Bool |
|
-> m () |
sets whether the indicator of self
is activatable.
If set to True
, indicatorActivated will be emitted when
the indicator is clicked.
If TabPage
:indicator-icon
is not set, does nothing.
Since: 1.2
setIndicatorIcon
tabPageSetIndicatorIcon Source #
:: (HasCallStack, MonadIO m, IsTabPage a, IsIcon b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the indicator icon of self
.
A common use case is an audio or camera indicator in a web browser.
TabPage
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.
If TabPage
:indicator-activatable
is set to True
, indicator icon
can act as a button.
Since: 1.2
setLoading
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Bool |
|
-> m () |
setNeedsAttention
tabPageSetNeedsAttention Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Bool |
|
-> m () |
setTitle
setTooltip
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, displayed next to the title.
TabBar
will not show the icon if TabPage
:loading
is set to True
,
or if the page is pinned and TabPage
: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
, indicatorActivated will be emitted when
the indicator icon is clicked.
If TabPage
: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.
TabPage
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.
If TabPage
: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
, TabBar
will display a spinner in place of icon.
If the page is pinned and TabPage
: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.
TabBar
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
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 tabViewSetPagePinned
.
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.
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.
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, marked up with the Pango text markup language.
If not set, TabBar
will use TabPage
: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 ]