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 |
- Exported types
- Methods
- getChild
- getIcon
- getIndicatorActivatable
- getIndicatorIcon
- getIndicatorTooltip
- getKeyword
- getLiveThumbnail
- getLoading
- getNeedsAttention
- getParent
- getPinned
- getSelected
- getThumbnailXalign
- getThumbnailYalign
- getTitle
- getTooltip
- invalidateThumbnail
- setIcon
- setIndicatorActivatable
- setIndicatorIcon
- setIndicatorTooltip
- setKeyword
- setLiveThumbnail
- setLoading
- setNeedsAttention
- setThumbnailXalign
- setThumbnailYalign
- setTitle
- setTooltip
- Properties
An auxiliary class used by [classtabView
].
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)
- tabPageGetIndicatorTooltip :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m Text
- tabPageGetKeyword :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m (Maybe Text)
- tabPageGetLiveThumbnail :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m Bool
- 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
- tabPageGetThumbnailXalign :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m Float
- tabPageGetThumbnailYalign :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m Float
- tabPageGetTitle :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m Text
- tabPageGetTooltip :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m (Maybe Text)
- tabPageInvalidateThumbnail :: (HasCallStack, MonadIO m, IsTabPage a) => a -> m ()
- 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 ()
- tabPageSetIndicatorTooltip :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Text -> m ()
- tabPageSetKeyword :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Text -> m ()
- tabPageSetLiveThumbnail :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Bool -> m ()
- tabPageSetLoading :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Bool -> m ()
- tabPageSetNeedsAttention :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Bool -> m ()
- tabPageSetThumbnailXalign :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Float -> m ()
- tabPageSetThumbnailYalign :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Float -> m ()
- tabPageSetTitle :: (HasCallStack, MonadIO m, IsTabPage a) => a -> Text -> m ()
- tabPageSetTooltip :: (HasCallStack, MonadIO m, IsTabPage a) => a -> 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 ()
- constructTabPageIndicatorTooltip :: (IsTabPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getTabPageIndicatorTooltip :: (MonadIO m, IsTabPage o) => o -> m Text
- setTabPageIndicatorTooltip :: (MonadIO m, IsTabPage o) => o -> Text -> m ()
- constructTabPageKeyword :: (IsTabPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getTabPageKeyword :: (MonadIO m, IsTabPage o) => o -> m (Maybe Text)
- setTabPageKeyword :: (MonadIO m, IsTabPage o) => o -> Text -> m ()
- constructTabPageLiveThumbnail :: (IsTabPage o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTabPageLiveThumbnail :: (MonadIO m, IsTabPage o) => o -> m Bool
- setTabPageLiveThumbnail :: (MonadIO m, IsTabPage o) => o -> Bool -> 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
- constructTabPageThumbnailXalign :: (IsTabPage o, MonadIO m) => Float -> m (GValueConstruct o)
- getTabPageThumbnailXalign :: (MonadIO m, IsTabPage o) => o -> m Float
- setTabPageThumbnailXalign :: (MonadIO m, IsTabPage o) => o -> Float -> m ()
- constructTabPageThumbnailYalign :: (IsTabPage o, MonadIO m) => Float -> m (GValueConstruct o)
- getTabPageThumbnailYalign :: (MonadIO m, IsTabPage o) => o -> m Float
- setTabPageThumbnailYalign :: (MonadIO m, IsTabPage o) => o -> Float -> m ()
- constructTabPageTitle :: (IsTabPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getTabPageTitle :: (MonadIO m, IsTabPage o) => o -> m Text
- setTabPageTitle :: (MonadIO m, IsTabPage o) => o -> Text -> 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.Adw.Objects.TabPage | |
ManagedPtrNewtype TabPage Source # | |
Defined in GI.Adw.Objects.TabPage toManagedPtr :: TabPage -> ManagedPtr TabPage | |
TypedObject TabPage Source # | |
Defined in GI.Adw.Objects.TabPage | |
HasParentTypes TabPage Source # | |
Defined in GI.Adw.Objects.TabPage | |
IsGValue (Maybe TabPage) Source # | Convert |
Defined in GI.Adw.Objects.TabPage gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe TabPage -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe TabPage) | |
type ParentTypes TabPage Source # | |
Defined in GI.Adw.Objects.TabPage type ParentTypes TabPage = '[Object, Accessible] |
class (GObject o, IsDescendantOf TabPage o) => IsTabPage o Source #
Instances
(GObject o, IsDescendantOf TabPage o) => IsTabPage o Source # | |
Defined in GI.Adw.Objects.TabPage |
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, invalidateThumbnail, isFloating, notify, notifyByPspec, ref, refSink, resetProperty, resetRelation, resetState, runDispose, stealData, stealQdata, thawNotify, unref, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getChild, getData, getFirstAccessibleChild, getIcon, getIndicatorActivatable, getIndicatorIcon, getIndicatorTooltip, getKeyword, getLiveThumbnail, getLoading, getNeedsAttention, getNextAccessibleSibling, getParent, getPinned, getPlatformState, getProperty, getQdata, getSelected, getThumbnailXalign, getThumbnailYalign, getTitle, getTooltip.
Setters
setAccessibleParent, setData, setDataFull, setIcon, setIndicatorActivatable, setIndicatorIcon, setIndicatorTooltip, setKeyword, setLiveThumbnail, setLoading, setNeedsAttention, setProperty, setThumbnailXalign, setThumbnailYalign, setTitle, setTooltip.
getChild
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Widget | Returns: the child of |
Gets the child of self
.
getIcon
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m (Maybe Icon) | Returns: the icon of |
Gets the icon of self
.
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.
getIndicatorIcon
tabPageGetIndicatorIcon Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m (Maybe Icon) | Returns: the indicator icon of |
Gets the indicator icon of self
.
getIndicatorTooltip
tabPageGetIndicatorTooltip Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Text | Returns: the indicator tooltip of |
Gets the tooltip of the indicator icon of self
.
Since: 1.2
getKeyword
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m (Maybe Text) | Returns: the search keyword of |
Gets the search keyword of self
.
Since: 1.3
getLiveThumbnail
tabPageGetLiveThumbnail Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Bool | Returns: whether live thumbnail is enabled |
Gets whether to live thumbnail is enabled self
.
Since: 1.3
getLoading
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Bool | Returns: whether |
Gets whether self
is loading.
getNeedsAttention
tabPageGetNeedsAttention Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Bool | Returns: whether |
Gets whether self
needs attention.
getParent
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m (Maybe TabPage) | Returns: the parent page |
Gets the parent page of self
.
See [methodtabView
.add_page] and [methodtabView
.close_page].
getPinned
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Bool | Returns: whether |
Gets whether self
is pinned.
See [methodtabView
.set_page_pinned].
getSelected
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Bool | Returns: whether |
Gets whether self
is selected.
getThumbnailXalign
tabPageGetThumbnailXalign Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Float | Returns: the horizontal alignment |
Gets the horizontal alignment of the thumbnail for self
.
Since: 1.3
getThumbnailYalign
tabPageGetThumbnailYalign Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Float | Returns: the vertical alignment |
Gets the vertical alignment of the thumbnail for self
.
Since: 1.3
getTitle
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m Text | Returns: the title of |
Gets the title of self
.
getTooltip
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m (Maybe Text) | Returns: the tooltip of |
Gets the tooltip of self
.
invalidateThumbnail
tabPageInvalidateThumbnail Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> m () |
Invalidates thumbnail for self
.
If an [classtabOverview
] is open, the thumbnail representing self
will be
immediately updated. Otherwise it will be update when opening the overview.
Does nothing if [propertytabPage
:live-thumbnail] is set to TRUE
.
See also [methodtabView
.invalidate_thumbnails].
Since: 1.3
setIcon
:: (HasCallStack, MonadIO m, IsTabPage a, IsIcon b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the icon of self
.
- class
tabBar
- and [class
tabOverview
] display the icon next to the title, unless [propertytabPage
:loading] is set toTRUE
.
AdwTabBar
also won't show the icon if the page is pinned and
[propertyTabPage:indicator-icon] is set.
setIndicatorActivatable
tabPageSetIndicatorActivatable Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the indicator of self
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.
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.
- class
tabBar
- will show it at the beginning of the tab, alongside icon
representing [property
tabPage
:icon] or loading spinner.
If the page is pinned, the indicator will be shown instead of icon or spinner.
- class
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 [propertytabPage
:indicator-activatable] is set to TRUE
, the
indicator icon can act as a button.
setIndicatorTooltip
tabPageSetIndicatorTooltip Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the tooltip of the indicator icon of self
.
The tooltip can be marked up with the Pango text markup language.
See [propertytabPage
:indicator-icon].
Since: 1.2
setKeyword
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the search keyword for self
.
- class
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.
Since: 1.3
setLiveThumbnail
tabPageSetLiveThumbnail Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether to enable live thumbnail for self
.
When set to TRUE
, self
's thumbnail in [classtabOverview
] 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
[methodtabPage
.invalidate_thumbnail] or
[methodtabView
.invalidate_thumbnails] is called.
Since: 1.3
setLoading
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether self
is loading.
If set to TRUE
, [classtabBar
] and [classtabOverview
] will display a
spinner in place of icon.
If the page is pinned and [propertytabPage
:indicator-icon] is set, loading
status will not be visible with AdwTabBar
.
setNeedsAttention
tabPageSetNeedsAttention Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether self
needs attention.
- class
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. - class
tabOverview
- will display a dot in the corner of the thumbnail if set
to
TRUE
. - class
tabButton
- will display a dot if any of the pages that aren't
selected have [property
tabPage
:needs-attention] set toTRUE
.
setThumbnailXalign
tabPageSetThumbnailXalign Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Float |
|
-> m () |
Sets the horizontal alignment of the thumbnail for self
.
If the page is so wide that [classtabOverview
] 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.
Since: 1.3
setThumbnailYalign
tabPageSetThumbnailYalign Source #
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Float |
|
-> m () |
Sets the vertical alignment of the thumbnail for self
.
If the page is so tall that [classtabOverview
] 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.
Since: 1.3
setTitle
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Text |
|
-> m () |
- class
tabBar
- will display it in the center of the tab unless it's pinned,
and will use it as a tooltip unless [property
tabPage
:tooltip] is set. - class
tabOverview
- will display it below the thumbnail unless it's pinned, or inside the card otherwise, and will use it as a tooltip unless
- property
tabPage
:tooltip - is set.
Sets the title of self
.
setTooltip
:: (HasCallStack, MonadIO m, IsTabPage a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the tooltip of self
.
The tooltip can be marked up with the Pango text markup language.
If not set, [classtabBar
] and [classtabOverview
] will use
[propertytabPage
:title] as a tooltip instead.
Properties
child
The child of the page.
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.
- class
tabBar
- and [class
tabOverview
] display the icon next to the title, unless [propertytabPage
:loading] is set toTRUE
.
AdwTabBar
also won't show the icon if the page is pinned and
[propertyTabPage:indicator-icon] is set.
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.
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.
- class
tabBar
- will show it at the beginning of the tab, alongside icon
representing [property
tabPage
:icon] or loading spinner.
If the page is pinned, the indicator will be shown instead of icon or spinner.
- class
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 [propertytabPage
:indicator-activatable] is set to TRUE
, the
indicator icon can act as a button.
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 ]
indicatorTooltip
The tooltip of the indicator icon.
The tooltip can be marked up with the Pango text markup language.
See [propertytabPage
:indicator-icon].
Since: 1.2
constructTabPageIndicatorTooltip :: (IsTabPage o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “indicator-tooltip
” property. This is rarely needed directly, but it is used by new
.
getTabPageIndicatorTooltip :: (MonadIO m, IsTabPage o) => o -> m Text Source #
Get the value of the “indicator-tooltip
” property.
When overloading is enabled, this is equivalent to
get
tabPage #indicatorTooltip
setTabPageIndicatorTooltip :: (MonadIO m, IsTabPage o) => o -> Text -> m () Source #
Set the value of the “indicator-tooltip
” property.
When overloading is enabled, this is equivalent to
set
tabPage [ #indicatorTooltip:=
value ]
keyword
The search keyboard of the page.
- class
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.
Since: 1.3
constructTabPageKeyword :: (IsTabPage o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “keyword
” property. This is rarely needed directly, but it is used by new
.
getTabPageKeyword :: (MonadIO m, IsTabPage o) => o -> m (Maybe Text) Source #
Get the value of the “keyword
” property.
When overloading is enabled, this is equivalent to
get
tabPage #keyword
setTabPageKeyword :: (MonadIO m, IsTabPage o) => o -> Text -> m () Source #
Set the value of the “keyword
” property.
When overloading is enabled, this is equivalent to
set
tabPage [ #keyword:=
value ]
liveThumbnail
Whether to enable live thumbnail for this page.
When set to TRUE
, the page's thumbnail in [classtabOverview
] will update
immediately when the page is redrawn or resized.
If it's set to FALSE
, the thumbnail will only be live when the page is
selected, and otherwise it will be static and will only update when
[methodtabPage
.invalidate_thumbnail] or
[methodtabView
.invalidate_thumbnails] is called.
Since: 1.3
constructTabPageLiveThumbnail :: (IsTabPage o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “live-thumbnail
” property. This is rarely needed directly, but it is used by new
.
getTabPageLiveThumbnail :: (MonadIO m, IsTabPage o) => o -> m Bool Source #
Get the value of the “live-thumbnail
” property.
When overloading is enabled, this is equivalent to
get
tabPage #liveThumbnail
setTabPageLiveThumbnail :: (MonadIO m, IsTabPage o) => o -> Bool -> m () Source #
Set the value of the “live-thumbnail
” property.
When overloading is enabled, this is equivalent to
set
tabPage [ #liveThumbnail:=
value ]
loading
Whether the page is loading.
If set to TRUE
, [classtabBar
] and [classtabOverview
] will display a
spinner in place of icon.
If the page is pinned and [propertytabPage
:indicator-icon] is set,
loading status will not be visible with AdwTabBar
.
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.
- class
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. - class
tabOverview
- will display a dot in the corner of the thumbnail if set
to
TRUE
. - class
tabButton
- will display a dot if any of the pages that aren't
selected have this property set to
TRUE
.
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].
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].
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.
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
thumbnailXalign
The horizontal alignment of the page thumbnail.
If the page is so wide that [classtabOverview
] 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.
Since: 1.3
constructTabPageThumbnailXalign :: (IsTabPage o, MonadIO m) => Float -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “thumbnail-xalign
” property. This is rarely needed directly, but it is used by new
.
getTabPageThumbnailXalign :: (MonadIO m, IsTabPage o) => o -> m Float Source #
Get the value of the “thumbnail-xalign
” property.
When overloading is enabled, this is equivalent to
get
tabPage #thumbnailXalign
setTabPageThumbnailXalign :: (MonadIO m, IsTabPage o) => o -> Float -> m () Source #
Set the value of the “thumbnail-xalign
” property.
When overloading is enabled, this is equivalent to
set
tabPage [ #thumbnailXalign:=
value ]
thumbnailYalign
The vertical alignment of the page thumbnail.
If the page is so tall that [classtabOverview
] 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.
Since: 1.3
constructTabPageThumbnailYalign :: (IsTabPage o, MonadIO m) => Float -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “thumbnail-yalign
” property. This is rarely needed directly, but it is used by new
.
getTabPageThumbnailYalign :: (MonadIO m, IsTabPage o) => o -> m Float Source #
Get the value of the “thumbnail-yalign
” property.
When overloading is enabled, this is equivalent to
get
tabPage #thumbnailYalign
setTabPageThumbnailYalign :: (MonadIO m, IsTabPage o) => o -> Float -> m () Source #
Set the value of the “thumbnail-yalign
” property.
When overloading is enabled, this is equivalent to
set
tabPage [ #thumbnailYalign:=
value ]
title
The title of the page.
- class
tabBar
- will display it in the center of the tab unless it's pinned,
and will use it as a tooltip unless [property
tabPage
:tooltip] is set. - class
tabOverview
- will display it below the thumbnail unless it's pinned, or inside the card otherwise, and will use it as a tooltip unless
- property
tabPage
:tooltip - is set.
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 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
] and [classtabOverview
] will use
[propertytabPage
:title] as a tooltip instead.
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 ]