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
- getEnableNewTab
- getEnableSearch
- getExtraDragPreload
- getInverted
- getOpen
- getSearchActive
- getSecondaryMenu
- getShowEndTitleButtons
- getShowStartTitleButtons
- getView
- new
- setChild
- setEnableNewTab
- setEnableSearch
- setExtraDragPreload
- setInverted
- setOpen
- setSecondaryMenu
- setShowEndTitleButtons
- setShowStartTitleButtons
- setView
- setupExtraDropTarget
- Properties
- Signals
A tab overview for [classtabView
].
<picture> <source srcset="tab-overview-dark.png" media="(prefers-color-scheme: dark)"> <img src="tab-overview.png" alt="tab-overview"> </picture>
AdwTabOverview
is a widget that can display tabs from an AdwTabView
in a
grid.
AdwTabOverview
shows a thumbnail for each tab. By default thumbnails are
static for all pages except the selected one. They can be made always live
by setting [propertytabPage
:live-thumbnail] to TRUE
, or refreshed with
[methodtabPage
.invalidate_thumbnail] or
[methodtabView
.invalidate_thumbnails] otherwise.
If the pages are too tall or too wide, the thumbnails will be cropped; use
[propertytabPage
:thumbnail-xalign] and [propertytabPage
:thumbnail-yalign] to
control which part of the page should be visible in this case.
Pinned tabs are shown as smaller cards without thumbnails above the other
tabs. Unlike in [classtabBar
], they still have titles, as well as an unpin
button.
AdwTabOverview
provides search in open tabs. It searches in tab titles and
tooltips, as well as [propertytabPage
:keyword].
If [propertytabOverview
:enable-new-tab] is set to TRUE
, a new tab button
will be shown. Connect to the signaltabOverview
[createTab] signal to use
it.
- property
tabOverview
:secondary-menu - can be used to provide a secondary menu for the overview. Use it to add extra actions, e.g. to open a new window or undo closed tab.
AdwTabOverview
is intended to be used as the direct child of the window,
with the rest of the window contents set as the [propertytabOverview
:child].
The child is expected to contain an [classtabView
].
AdwTabOverview
shows window buttons by default. They can be disabled by
setting [propertytabOverview
:show-start-title-buttons] and/or
[propertytabOverview
:show-start-title-buttons] and/or
[propertytabOverview
:show-end-title-buttons] to FALSE
.
If search and window buttons are disabled, and secondary menu is not set, the header bar will be hidden.
Actions
AdwTabOverview
defines the overview.open
and overview.close
actions for
opening and closing itself. They can be convenient when used together with
[classtabButton
].
CSS nodes
AdwTabOverview
has a single CSS node with name taboverview
.
Since: 1.3
Synopsis
- newtype TabOverview = TabOverview (ManagedPtr TabOverview)
- class (GObject o, IsDescendantOf TabOverview o) => IsTabOverview o
- toTabOverview :: (MonadIO m, IsTabOverview o) => o -> m TabOverview
- tabOverviewGetChild :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> m (Maybe Widget)
- tabOverviewGetEnableNewTab :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> m Bool
- tabOverviewGetEnableSearch :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> m Bool
- tabOverviewGetExtraDragPreload :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> m Bool
- tabOverviewGetInverted :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> m Bool
- tabOverviewGetOpen :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> m Bool
- tabOverviewGetSearchActive :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> m Bool
- tabOverviewGetSecondaryMenu :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> m (Maybe MenuModel)
- tabOverviewGetShowEndTitleButtons :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> m Bool
- tabOverviewGetShowStartTitleButtons :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> m Bool
- tabOverviewGetView :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> m (Maybe TabView)
- tabOverviewNew :: (HasCallStack, MonadIO m) => m TabOverview
- tabOverviewSetChild :: (HasCallStack, MonadIO m, IsTabOverview a, IsWidget b) => a -> Maybe b -> m ()
- tabOverviewSetEnableNewTab :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> Bool -> m ()
- tabOverviewSetEnableSearch :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> Bool -> m ()
- tabOverviewSetExtraDragPreload :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> Bool -> m ()
- tabOverviewSetInverted :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> Bool -> m ()
- tabOverviewSetOpen :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> Bool -> m ()
- tabOverviewSetSecondaryMenu :: (HasCallStack, MonadIO m, IsTabOverview a, IsMenuModel b) => a -> Maybe b -> m ()
- tabOverviewSetShowEndTitleButtons :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> Bool -> m ()
- tabOverviewSetShowStartTitleButtons :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> Bool -> m ()
- tabOverviewSetView :: (HasCallStack, MonadIO m, IsTabOverview a, IsTabView b) => a -> Maybe b -> m ()
- tabOverviewSetupExtraDropTarget :: (HasCallStack, MonadIO m, IsTabOverview a) => a -> [DragAction] -> Maybe [GType] -> m ()
- clearTabOverviewChild :: (MonadIO m, IsTabOverview o) => o -> m ()
- constructTabOverviewChild :: (IsTabOverview o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getTabOverviewChild :: (MonadIO m, IsTabOverview o) => o -> m (Maybe Widget)
- setTabOverviewChild :: (MonadIO m, IsTabOverview o, IsWidget a) => o -> a -> m ()
- constructTabOverviewEnableNewTab :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTabOverviewEnableNewTab :: (MonadIO m, IsTabOverview o) => o -> m Bool
- setTabOverviewEnableNewTab :: (MonadIO m, IsTabOverview o) => o -> Bool -> m ()
- constructTabOverviewEnableSearch :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTabOverviewEnableSearch :: (MonadIO m, IsTabOverview o) => o -> m Bool
- setTabOverviewEnableSearch :: (MonadIO m, IsTabOverview o) => o -> Bool -> m ()
- constructTabOverviewExtraDragPreload :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTabOverviewExtraDragPreload :: (MonadIO m, IsTabOverview o) => o -> m Bool
- setTabOverviewExtraDragPreload :: (MonadIO m, IsTabOverview o) => o -> Bool -> m ()
- constructTabOverviewInverted :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTabOverviewInverted :: (MonadIO m, IsTabOverview o) => o -> m Bool
- setTabOverviewInverted :: (MonadIO m, IsTabOverview o) => o -> Bool -> m ()
- constructTabOverviewOpen :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTabOverviewOpen :: (MonadIO m, IsTabOverview o) => o -> m Bool
- setTabOverviewOpen :: (MonadIO m, IsTabOverview o) => o -> Bool -> m ()
- getTabOverviewSearchActive :: (MonadIO m, IsTabOverview o) => o -> m Bool
- clearTabOverviewSecondaryMenu :: (MonadIO m, IsTabOverview o) => o -> m ()
- constructTabOverviewSecondaryMenu :: (IsTabOverview o, MonadIO m, IsMenuModel a) => a -> m (GValueConstruct o)
- getTabOverviewSecondaryMenu :: (MonadIO m, IsTabOverview o) => o -> m (Maybe MenuModel)
- setTabOverviewSecondaryMenu :: (MonadIO m, IsTabOverview o, IsMenuModel a) => o -> a -> m ()
- constructTabOverviewShowEndTitleButtons :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTabOverviewShowEndTitleButtons :: (MonadIO m, IsTabOverview o) => o -> m Bool
- setTabOverviewShowEndTitleButtons :: (MonadIO m, IsTabOverview o) => o -> Bool -> m ()
- constructTabOverviewShowStartTitleButtons :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTabOverviewShowStartTitleButtons :: (MonadIO m, IsTabOverview o) => o -> m Bool
- setTabOverviewShowStartTitleButtons :: (MonadIO m, IsTabOverview o) => o -> Bool -> m ()
- clearTabOverviewView :: (MonadIO m, IsTabOverview o) => o -> m ()
- constructTabOverviewView :: (IsTabOverview o, MonadIO m, IsTabView a) => a -> m (GValueConstruct o)
- getTabOverviewView :: (MonadIO m, IsTabOverview o) => o -> m (Maybe TabView)
- setTabOverviewView :: (MonadIO m, IsTabOverview o, IsTabView a) => o -> a -> m ()
- type TabOverviewCreateTabCallback = IO TabPage
- afterTabOverviewCreateTab :: (IsTabOverview a, MonadIO m) => a -> ((?self :: a) => TabOverviewCreateTabCallback) -> m SignalHandlerId
- onTabOverviewCreateTab :: (IsTabOverview a, MonadIO m) => a -> ((?self :: a) => TabOverviewCreateTabCallback) -> m SignalHandlerId
- type TabOverviewExtraDragDropCallback = TabPage -> GValue -> IO Bool
- afterTabOverviewExtraDragDrop :: (IsTabOverview a, MonadIO m) => a -> ((?self :: a) => TabOverviewExtraDragDropCallback) -> m SignalHandlerId
- onTabOverviewExtraDragDrop :: (IsTabOverview a, MonadIO m) => a -> ((?self :: a) => TabOverviewExtraDragDropCallback) -> m SignalHandlerId
- type TabOverviewExtraDragValueCallback = TabPage -> GValue -> IO [DragAction]
- afterTabOverviewExtraDragValue :: (IsTabOverview a, MonadIO m) => a -> ((?self :: a) => TabOverviewExtraDragValueCallback) -> m SignalHandlerId
- onTabOverviewExtraDragValue :: (IsTabOverview a, MonadIO m) => a -> ((?self :: a) => TabOverviewExtraDragValueCallback) -> m SignalHandlerId
Exported types
newtype TabOverview Source #
Memory-managed wrapper type.
TabOverview (ManagedPtr TabOverview) |
Instances
Eq TabOverview Source # | |
Defined in GI.Adw.Objects.TabOverview (==) :: TabOverview -> TabOverview -> Bool # (/=) :: TabOverview -> TabOverview -> Bool # | |
GObject TabOverview Source # | |
Defined in GI.Adw.Objects.TabOverview | |
ManagedPtrNewtype TabOverview Source # | |
Defined in GI.Adw.Objects.TabOverview toManagedPtr :: TabOverview -> ManagedPtr TabOverview | |
TypedObject TabOverview Source # | |
Defined in GI.Adw.Objects.TabOverview | |
HasParentTypes TabOverview Source # | |
Defined in GI.Adw.Objects.TabOverview | |
IsGValue (Maybe TabOverview) Source # | Convert |
Defined in GI.Adw.Objects.TabOverview gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe TabOverview -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe TabOverview) | |
type ParentTypes TabOverview Source # | |
Defined in GI.Adw.Objects.TabOverview type ParentTypes TabOverview = '[Widget, Object, Accessible, Buildable, ConstraintTarget] |
class (GObject o, IsDescendantOf TabOverview o) => IsTabOverview o Source #
Type class for types which can be safely cast to TabOverview
, for instance with toTabOverview
.
Instances
(GObject o, IsDescendantOf TabOverview o) => IsTabOverview o Source # | |
Defined in GI.Adw.Objects.TabOverview |
toTabOverview :: (MonadIO m, IsTabOverview o) => o -> m TabOverview Source #
Cast to TabOverview
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
Methods
actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, setupExtraDropTarget, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBounds, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getEnableNewTab, getEnableSearch, getExtraDragPreload, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getInverted, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOpen, getOverflow, getPangoContext, getParent, getPlatformState, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSearchActive, getSecondaryMenu, getSensitive, getSettings, getShowEndTitleButtons, getShowStartTitleButtons, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getView, getVisible, getWidth.
Setters
setAccessibleParent, setCanFocus, setCanTarget, setChild, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setEnableNewTab, setEnableSearch, setExtraDragPreload, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setInverted, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOpen, setOverflow, setParent, setProperty, setReceivesDefault, setSecondaryMenu, setSensitive, setShowEndTitleButtons, setShowStartTitleButtons, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setView, setVisible.
getChild
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> m (Maybe Widget) | Returns: the child widget of |
Gets the child widget of self
.
Since: 1.3
getEnableNewTab
tabOverviewGetEnableNewTab Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> m Bool | Returns: whether new tab button is enabled |
Gets whether to new tab button is enabled for self
.
Since: 1.3
getEnableSearch
tabOverviewGetEnableSearch Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> m Bool | Returns: whether search is enabled |
Gets whether search in tabs is enabled for self
.
Since: 1.3
getExtraDragPreload
tabOverviewGetExtraDragPreload Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> m Bool | Returns: whether drop data should be preloaded on hover |
Gets whether drop data should be preloaded on hover.
Since: 1.3
getInverted
tabOverviewGetInverted Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> m Bool | Returns: whether thumbnails use inverted layout |
Gets whether thumbnails use inverted layout.
Since: 1.3
getOpen
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> m Bool | Returns: whether the overview is open |
Gets whether self
is open.
Since: 1.3
getSearchActive
tabOverviewGetSearchActive Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> m Bool | Returns: whether search is active |
Gets whether search is currently active for self
.
See [propertytabOverview
:enable-search].
Since: 1.3
getSecondaryMenu
tabOverviewGetSecondaryMenu Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> m (Maybe MenuModel) | Returns: the secondary menu model |
Gets the secondary menu model for self
.
Since: 1.3
getShowEndTitleButtons
tabOverviewGetShowEndTitleButtons Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> m Bool | Returns: whether end title buttons are shown |
Gets whether end title buttons are shown in self
's header bar.
Since: 1.3
getShowStartTitleButtons
tabOverviewGetShowStartTitleButtons Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> m Bool | Returns: whether start title buttons are shown |
Gets whether start title buttons are shown in self
's header bar.
Since: 1.3
getView
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> m (Maybe TabView) | Returns: the tab view |
Gets the tab view self
controls.
Since: 1.3
new
:: (HasCallStack, MonadIO m) | |
=> m TabOverview | Returns: the newly created |
Creates a new AdwTabOverview
.
Since: 1.3
setChild
:: (HasCallStack, MonadIO m, IsTabOverview a, IsWidget b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the child widget of self
.
Since: 1.3
setEnableNewTab
tabOverviewSetEnableNewTab Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether to enable new tab button for self
.
Connect to the signaltabOverview
[createTab] signal to use it.
Since: 1.3
setEnableSearch
tabOverviewSetEnableSearch Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether to enable search in tabs for self
.
Search matches tab titles and tooltips, as well as keywords, set via
[propertytabPage
:keyword]. Use keywords to search in e.g. page URLs in a web
browser.
During search, tab reordering and drag-n-drop are disabled.
Use [propertytabOverview
:search-active] to check out if search is currently
active.
Since: 1.3
setExtraDragPreload
tabOverviewSetExtraDragPreload Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> Bool |
|
-> m () |
setInverted
tabOverviewSetInverted Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether thumbnails use inverted layout.
If set to TRUE
, thumbnails will have the close or unpin button at the
beginning and the indicator at the end rather than the other way around.
Since: 1.3
setOpen
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the to open self
.
Since: 1.3
setSecondaryMenu
tabOverviewSetSecondaryMenu Source #
:: (HasCallStack, MonadIO m, IsTabOverview a, IsMenuModel b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the secondary menu model for self
.
Use it to add extra actions, e.g. to open a new window or undo closed tab.
Since: 1.3
setShowEndTitleButtons
tabOverviewSetShowEndTitleButtons Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether to show end title buttons in self
's header bar.
See [propertyheaderBar
:show-start-title-buttons] for the other side.
Since: 1.3
setShowStartTitleButtons
tabOverviewSetShowStartTitleButtons Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether to show start title buttons in self
's header bar.
See [propertyheaderBar
:show-end-title-buttons] for the other side.
Since: 1.3
setView
:: (HasCallStack, MonadIO m, IsTabOverview a, IsTabView b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the tab view to control.
The view must be inside self
, see [propertytabOverview
:child].
Since: 1.3
setupExtraDropTarget
tabOverviewSetupExtraDropTarget Source #
:: (HasCallStack, MonadIO m, IsTabOverview a) | |
=> a |
|
-> [DragAction] |
|
-> Maybe [GType] |
|
-> m () |
Sets the supported types for this drop target.
Sets up an extra drop target on tabs.
This allows to drag arbitrary content onto tabs, for example URLs in a web browser.
If a tab is hovered for a certain period of time while dragging the content, it will be automatically selected.
The signaltabOverview
[extraDragDrop] signal can be used to handle the
drop.
Since: 1.3
Properties
child
The child widget.
Since: 1.3
clearTabOverviewChild :: (MonadIO m, IsTabOverview o) => o -> m () Source #
Set the value of the “child
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#child
constructTabOverviewChild :: (IsTabOverview 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
.
getTabOverviewChild :: (MonadIO m, IsTabOverview o) => o -> m (Maybe Widget) Source #
Get the value of the “child
” property.
When overloading is enabled, this is equivalent to
get
tabOverview #child
setTabOverviewChild :: (MonadIO m, IsTabOverview o, IsWidget a) => o -> a -> m () Source #
Set the value of the “child
” property.
When overloading is enabled, this is equivalent to
set
tabOverview [ #child:=
value ]
enableNewTab
Whether to enable new tab button.
Connect to the signaltabOverview
[createTab] signal to use it.
Since: 1.3
constructTabOverviewEnableNewTab :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “enable-new-tab
” property. This is rarely needed directly, but it is used by new
.
getTabOverviewEnableNewTab :: (MonadIO m, IsTabOverview o) => o -> m Bool Source #
Get the value of the “enable-new-tab
” property.
When overloading is enabled, this is equivalent to
get
tabOverview #enableNewTab
setTabOverviewEnableNewTab :: (MonadIO m, IsTabOverview o) => o -> Bool -> m () Source #
Set the value of the “enable-new-tab
” property.
When overloading is enabled, this is equivalent to
set
tabOverview [ #enableNewTab:=
value ]
enableSearch
Whether to enable search in tabs.
Search matches tab titles and tooltips, as well as keywords, set via
[propertytabPage
:keyword]. Use keywords to search in e.g. page URLs in a
web browser.
During search, tab reordering and drag-n-drop are disabled.
Use [propertytabOverview
:search-active] to check out if search is
currently active.
Since: 1.3
constructTabOverviewEnableSearch :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “enable-search
” property. This is rarely needed directly, but it is used by new
.
getTabOverviewEnableSearch :: (MonadIO m, IsTabOverview o) => o -> m Bool Source #
Get the value of the “enable-search
” property.
When overloading is enabled, this is equivalent to
get
tabOverview #enableSearch
setTabOverviewEnableSearch :: (MonadIO m, IsTabOverview o) => o -> Bool -> m () Source #
Set the value of the “enable-search
” property.
When overloading is enabled, this is equivalent to
set
tabOverview [ #enableSearch:=
value ]
extraDragPreload
constructTabOverviewExtraDragPreload :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “extra-drag-preload
” property. This is rarely needed directly, but it is used by new
.
getTabOverviewExtraDragPreload :: (MonadIO m, IsTabOverview o) => o -> m Bool Source #
Get the value of the “extra-drag-preload
” property.
When overloading is enabled, this is equivalent to
get
tabOverview #extraDragPreload
setTabOverviewExtraDragPreload :: (MonadIO m, IsTabOverview o) => o -> Bool -> m () Source #
Set the value of the “extra-drag-preload
” property.
When overloading is enabled, this is equivalent to
set
tabOverview [ #extraDragPreload:=
value ]
inverted
Whether thumbnails use inverted layout.
If set to TRUE
, thumbnails will have the close or unpin buttons at the
beginning and the indicator at the end rather than the other way around.
Since: 1.3
constructTabOverviewInverted :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “inverted
” property. This is rarely needed directly, but it is used by new
.
getTabOverviewInverted :: (MonadIO m, IsTabOverview o) => o -> m Bool Source #
Get the value of the “inverted
” property.
When overloading is enabled, this is equivalent to
get
tabOverview #inverted
setTabOverviewInverted :: (MonadIO m, IsTabOverview o) => o -> Bool -> m () Source #
Set the value of the “inverted
” property.
When overloading is enabled, this is equivalent to
set
tabOverview [ #inverted:=
value ]
open
Whether the overview is open.
Since: 1.3
constructTabOverviewOpen :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “open
” property. This is rarely needed directly, but it is used by new
.
getTabOverviewOpen :: (MonadIO m, IsTabOverview o) => o -> m Bool Source #
Get the value of the “open
” property.
When overloading is enabled, this is equivalent to
get
tabOverview #open
setTabOverviewOpen :: (MonadIO m, IsTabOverview o) => o -> Bool -> m () Source #
Set the value of the “open
” property.
When overloading is enabled, this is equivalent to
set
tabOverview [ #open:=
value ]
searchActive
Whether search is currently active.
See [propertytabOverview
:enable-search].
Since: 1.3
getTabOverviewSearchActive :: (MonadIO m, IsTabOverview o) => o -> m Bool Source #
Get the value of the “search-active
” property.
When overloading is enabled, this is equivalent to
get
tabOverview #searchActive
secondaryMenu
The secondary menu model.
Use it to add extra actions, e.g. to open a new window or undo closed tab.
Since: 1.3
clearTabOverviewSecondaryMenu :: (MonadIO m, IsTabOverview o) => o -> m () Source #
Set the value of the “secondary-menu
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#secondaryMenu
constructTabOverviewSecondaryMenu :: (IsTabOverview o, MonadIO m, IsMenuModel a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “secondary-menu
” property. This is rarely needed directly, but it is used by new
.
getTabOverviewSecondaryMenu :: (MonadIO m, IsTabOverview o) => o -> m (Maybe MenuModel) Source #
Get the value of the “secondary-menu
” property.
When overloading is enabled, this is equivalent to
get
tabOverview #secondaryMenu
setTabOverviewSecondaryMenu :: (MonadIO m, IsTabOverview o, IsMenuModel a) => o -> a -> m () Source #
Set the value of the “secondary-menu
” property.
When overloading is enabled, this is equivalent to
set
tabOverview [ #secondaryMenu:=
value ]
showEndTitleButtons
Whether to show end title buttons in the overview's header bar.
See [propertyheaderBar
:show-start-title-buttons] for the other side.
Since: 1.3
constructTabOverviewShowEndTitleButtons :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “show-end-title-buttons
” property. This is rarely needed directly, but it is used by new
.
getTabOverviewShowEndTitleButtons :: (MonadIO m, IsTabOverview o) => o -> m Bool Source #
Get the value of the “show-end-title-buttons
” property.
When overloading is enabled, this is equivalent to
get
tabOverview #showEndTitleButtons
setTabOverviewShowEndTitleButtons :: (MonadIO m, IsTabOverview o) => o -> Bool -> m () Source #
Set the value of the “show-end-title-buttons
” property.
When overloading is enabled, this is equivalent to
set
tabOverview [ #showEndTitleButtons:=
value ]
showStartTitleButtons
Whether to show start title buttons in the overview's header bar.
See [propertyheaderBar
:show-end-title-buttons] for the other side.
Since: 1.3
constructTabOverviewShowStartTitleButtons :: (IsTabOverview o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “show-start-title-buttons
” property. This is rarely needed directly, but it is used by new
.
getTabOverviewShowStartTitleButtons :: (MonadIO m, IsTabOverview o) => o -> m Bool Source #
Get the value of the “show-start-title-buttons
” property.
When overloading is enabled, this is equivalent to
get
tabOverview #showStartTitleButtons
setTabOverviewShowStartTitleButtons :: (MonadIO m, IsTabOverview o) => o -> Bool -> m () Source #
Set the value of the “show-start-title-buttons
” property.
When overloading is enabled, this is equivalent to
set
tabOverview [ #showStartTitleButtons:=
value ]
view
The tab view the overview controls.
The view must be inside the tab overview, see [propertytabOverview
:child].
Since: 1.3
clearTabOverviewView :: (MonadIO m, IsTabOverview o) => o -> m () Source #
Set the value of the “view
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#view
constructTabOverviewView :: (IsTabOverview o, MonadIO m, IsTabView a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “view
” property. This is rarely needed directly, but it is used by new
.
getTabOverviewView :: (MonadIO m, IsTabOverview o) => o -> m (Maybe TabView) Source #
Get the value of the “view
” property.
When overloading is enabled, this is equivalent to
get
tabOverview #view
setTabOverviewView :: (MonadIO m, IsTabOverview o, IsTabView a) => o -> a -> m () Source #
Set the value of the “view
” property.
When overloading is enabled, this is equivalent to
set
tabOverview [ #view:=
value ]
Signals
createTab
type TabOverviewCreateTabCallback Source #
Emitted when a tab needs to be created;
This can happen after the new tab button has been pressed, see
[propertytabOverview
:enable-new-tab].
The signal handler is expected to create a new page in the corresponding
[classtabView
] and return it.
Since: 1.3
afterTabOverviewCreateTab :: (IsTabOverview a, MonadIO m) => a -> ((?self :: a) => TabOverviewCreateTabCallback) -> m SignalHandlerId Source #
Connect a signal handler for the createTab signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
tabOverview #createTab callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onTabOverviewCreateTab :: (IsTabOverview a, MonadIO m) => a -> ((?self :: a) => TabOverviewCreateTabCallback) -> m SignalHandlerId Source #
Connect a signal handler for the createTab signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
tabOverview #createTab callback
extraDragDrop
type TabOverviewExtraDragDropCallback Source #
= TabPage |
|
-> GValue |
|
-> IO Bool | Returns: whether the drop was accepted for |
This signal is emitted when content is dropped onto a tab.
The content must be of one of the types set up via
[methodtabOverview
.setup_extra_drop_target].
See DropTarget::drop.
Since: 1.3
afterTabOverviewExtraDragDrop :: (IsTabOverview a, MonadIO m) => a -> ((?self :: a) => TabOverviewExtraDragDropCallback) -> m SignalHandlerId Source #
Connect a signal handler for the extraDragDrop signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
tabOverview #extraDragDrop callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onTabOverviewExtraDragDrop :: (IsTabOverview a, MonadIO m) => a -> ((?self :: a) => TabOverviewExtraDragDropCallback) -> m SignalHandlerId Source #
Connect a signal handler for the extraDragDrop signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
tabOverview #extraDragDrop callback
extraDragValue
type TabOverviewExtraDragValueCallback Source #
= TabPage |
|
-> GValue |
|
-> IO [DragAction] | Returns: the preferred action for the drop on |
This signal is emitted when the dropped content is preloaded.
In order for data to be preloaded, [propertytabOverview
:extra-drag-preload]
must be set to TRUE
.
The content must be of one of the types set up via
[methodtabOverview
.setup_extra_drop_target].
See DropTarget:value.
Since: 1.3
afterTabOverviewExtraDragValue :: (IsTabOverview a, MonadIO m) => a -> ((?self :: a) => TabOverviewExtraDragValueCallback) -> m SignalHandlerId Source #
Connect a signal handler for the extraDragValue signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
tabOverview #extraDragValue callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onTabOverviewExtraDragValue :: (IsTabOverview a, MonadIO m) => a -> ((?self :: a) => TabOverviewExtraDragValueCallback) -> m SignalHandlerId Source #
Connect a signal handler for the extraDragValue signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
tabOverview #extraDragValue callback