GI.Wnck.Objects.Pager

The Pager struct contains only private fields and should not be directly accessed.

Exported types

newtype Pager

Memory-managed wrapper type.

Constructors

Pager (ManagedPtr Pager)

Instances

GObject Pager

Defined in GI.Wnck.Objects.Pager

Methods

gobjectType :: IO GType

HasParentTypes Pager

Defined in GI.Wnck.Objects.Pager

type ParentTypes Pager

Defined in GI.Wnck.Objects.Pager

type ParentTypes Pager = Widget ': (Object ': (ImplementorIface ': (Buildable ': ([] :: [Type]))))

class (GObject o, IsDescendantOf Pager o) => IsPager o

Type class for types which can be safely cast to Pager, for instance with toPager.

Instances

(GObject o, IsDescendantOf Pager o) => IsPager o

Defined in GI.Wnck.Objects.Pager

toPager :: (MonadIO m, IsPager o) => o -> m Pager

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

noPager :: Maybe Pager

A convenience alias for Nothing :: Maybe Pager.

Methods

getWrapOnScroll

pagerGetWrapOnScroll

Arguments

:: (HasCallStack, MonadIO m, IsPager a)

=> a

pager: a Pager.

-> m Bool

Returns: True if the pager wraps workspaces on a scroll event that hits a border, False otherwise.

No description available in the introspection data.

Since: 3.24.0

new

pagerNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Pager

Returns: a newly created Pager.

Creates a new Pager. The Pager will show the Workspace of the Screen it is on.

setDisplayMode

pagerSetDisplayMode

Arguments

:: (HasCallStack, MonadIO m, IsPager a)

=> a

pager: a Pager.

-> PagerDisplayMode

mode: a display mode.

-> m ()

Sets the display mode for pager to mode.

setNRows

pagerSetNRows

Arguments

:: (HasCallStack, MonadIO m, IsPager a)

=> a

pager: a Pager.

-> Int32

nRows: the number of rows to use for the layout of Workspace on the Screen pager is watching.

-> m Bool

Returns: True if the layout of Workspace has been successfully changed or did not need to be changed, False otherwise.

Tries to change the number of rows in the layout of Workspace on the Screen pager is watching. Since no more than one application should set this property of a Screen at a time, setting the layout is not guaranteed to work.

If pager has not been added to a widget hierarchy, the call will fail because pager can't know the screen on which to modify the layout.

setOrientation

pagerSetOrientation

Arguments

:: (HasCallStack, MonadIO m, IsPager a)

=> a

pager: a Pager.

-> Orientation

orientation: orientation to use for the layout of Workspace on the Screen pager is watching.

-> m Bool

Returns: True if the layout of Workspace has been successfully changed or did not need to be changed, False otherwise.

Tries to change the orientation of the layout of Workspace on the Screen pager is watching. Since no more than one application should set this property of a Screen at a time, setting the layout is not guaranteed to work.

If orientation is OrientationHorizontal, the Workspace will be laid out in rows, with the first Workspace in the top left corner.

If orientation is OrientationVertical, the Workspace will be laid out in columns, with the first Workspace in the top left corner.

For example, if the layout contains one row, but the orientation of the layout is vertical, the Pager will display a column of Workspace.

Note that setting the orientation will have an effect on the geometry management: if orientation is OrientationHorizontal, SizeRequestModeWidthForHeight will be used as request mode; if orientation is OrientationVertical, GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH will be used instead.

If pager has not been added to a widget hierarchy, the call will fail because pager can't know the screen on which to modify the orientation.

setShadowType

pagerSetShadowType

Arguments

:: (HasCallStack, MonadIO m, IsPager a)

=> a

pager: a Pager.

-> ShadowType

shadowType: a shadow type.

-> m ()

Sets the shadow type for pager to shadowType. The main use of this function is proper integration of Pager in panels with non-system backgrounds.

Since: 2.2

setShowAll

pagerSetShowAll

Arguments

:: (HasCallStack, MonadIO m, IsPager a)

=> a

pager: a Pager.

-> Bool

showAllWorkspaces: whether to display all Workspace in pager.

-> m ()

Sets pager to display all Workspace or not, according to showAllWorkspaces.

setWrapOnScroll

pagerSetWrapOnScroll

Arguments

:: (HasCallStack, MonadIO m, IsPager a)

=> a

pager: a Pager.

-> Bool

wrapOnScroll: a boolean.

-> m ()

Sets the wrapping behavior of the pager. Setting it to True will wrap arround to the start when scrolling over the end and vice versa. By default it is set to False.

Since: 3.24.0