gi-gtk-3.0.43: Gtk bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.SeparatorToolItem

Contents

- Exported types
- Methods
  - getDraw
  - new
  - setDraw
- Properties
  - draw

Description

A `SeparatorToolItem` is a `ToolItem` that separates groups of other `GtkToolItems`. Depending on the theme, a `SeparatorToolItem` will often look like a vertical line on horizontally docked toolbars.

If the `Toolbar` child property “expand” is `True` and the property SeparatorToolItem:draw is `False`, a `SeparatorToolItem` will act as a “spring” that forces other items to the ends of the toolbar.

Use `separatorToolItemNew` to create a new `SeparatorToolItem`.

# CSS nodes

GtkSeparatorToolItem has a single CSS node with name separator.

Synopsis

- newtype SeparatorToolItem = SeparatorToolItem (ManagedPtr SeparatorToolItem)
- class (GObject o, IsDescendantOf SeparatorToolItem o) => IsSeparatorToolItem o
- toSeparatorToolItem :: (MonadIO m, IsSeparatorToolItem o) => o -> m SeparatorToolItem
- separatorToolItemGetDraw :: (HasCallStack, MonadIO m, IsSeparatorToolItem a) => a -> m Bool
- separatorToolItemNew :: (HasCallStack, MonadIO m) => m SeparatorToolItem
- separatorToolItemSetDraw :: (HasCallStack, MonadIO m, IsSeparatorToolItem a) => a -> Bool -> m ()
- constructSeparatorToolItemDraw :: (IsSeparatorToolItem o, MonadIO m) => Bool -> m (GValueConstruct o)
- getSeparatorToolItemDraw :: (MonadIO m, IsSeparatorToolItem o) => o -> m Bool
- setSeparatorToolItemDraw :: (MonadIO m, IsSeparatorToolItem o) => o -> Bool -> m ()

# Exported types

newtype SeparatorToolItem Source #

Memory-managed wrapper type.

Constructors

SeparatorToolItem (ManagedPtr SeparatorToolItem) |

#### Instances

Instances details

Eq SeparatorToolItem Source # |
Instance details Defined in GI.Gtk.Objects.SeparatorToolItem Methods (==) :: SeparatorToolItem -> SeparatorToolItem -> Bool Source # (/=) :: SeparatorToolItem -> SeparatorToolItem -> Bool Source #
GObject SeparatorToolItem Source # |
Instance details Defined in GI.Gtk.Objects.SeparatorToolItem
ManagedPtrNewtype SeparatorToolItem Source # |
Instance details Defined in GI.Gtk.Objects.SeparatorToolItem Methods toManagedPtr :: SeparatorToolItem -> ManagedPtr SeparatorToolItem Source #
TypedObject SeparatorToolItem Source # |
Instance details Defined in GI.Gtk.Objects.SeparatorToolItem Methods glibType :: IO GType Source #
HasParentTypes SeparatorToolItem Source # |
Instance details Defined in GI.Gtk.Objects.SeparatorToolItem
IsGValue (Maybe SeparatorToolItem) Source # | Convert `SeparatorToolItem` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.SeparatorToolItem Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe SeparatorToolItem -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe SeparatorToolItem) Source #
type ParentTypes SeparatorToolItem Source # |
Instance details Defined in GI.Gtk.Objects.SeparatorToolItem type ParentTypes SeparatorToolItem = '[ToolItem, Bin, Container, Widget, Object, ImplementorIface, Activatable, Buildable]

class (GObject o, IsDescendantOf SeparatorToolItem o) => IsSeparatorToolItem o Source #

Type class for types which can be safely cast to `SeparatorToolItem`, for instance with `toSeparatorToolItem`.

#### Instances

Instances details

(GObject o, IsDescendantOf SeparatorToolItem o) => IsSeparatorToolItem o Source # |
Instance details Defined in GI.Gtk.Objects.SeparatorToolItem

toSeparatorToolItem :: (MonadIO m, IsSeparatorToolItem o) => o -> m SeparatorToolItem Source #

Cast to `SeparatorToolItem`, 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

Expand

#### Methods

activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, doSetRelatedAction, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, rebuildMenu, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, retrieveProxyMenuItem, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, syncActionProperties, thawChildNotify, thawNotify, toolbarReconfigured, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

#### Getters

getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getDraw, getEllipsizeMode, getEvents, getExpand, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHomogeneous, getIconSize, getInternalChild, getIsImportant, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getOrientation, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getProxyMenuItem, getQdata, getRealized, getReceivesDefault, getRelatedAction, getReliefStyle, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTextAlignment, getTextOrientation, getTextSizeGroup, getToolbarStyle, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getUseActionAppearance, getUseDragWindow, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisibleHorizontal, getVisibleVertical, getVisual, getWindow.

#### Setters

setAccelPath, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setDraw, setEvents, setExpand, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setHomogeneous, setIsImportant, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setProxyMenuItem, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setRelatedAction, setResizeMode, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseActionAppearance, setUseDragWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisibleHorizontal, setVisibleVertical, setVisual, setWindow.

## getDraw

separatorToolItemGetDraw Source #

Arguments

:: (HasCallStack, MonadIO m, IsSeparatorToolItem a) |
=> a | `item`: a `SeparatorToolItem`
-> m Bool | Returns: `True` if `item` is drawn as a line, or just blank.

Returns whether `item` is drawn as a line, or just blank. See `separatorToolItemSetDraw`.

Since: 2.4

## new

separatorToolItemNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m SeparatorToolItem | Returns: the new `SeparatorToolItem`

Create a new `SeparatorToolItem`

Since: 2.4

## setDraw

separatorToolItemSetDraw Source #

Arguments

:: (HasCallStack, MonadIO m, IsSeparatorToolItem a) |
=> a | `item`: a `SeparatorToolItem`
-> Bool | `draw`: whether `item` is drawn as a vertical line
-> m () |

Whether `item` is drawn as a vertical line, or just blank. Setting this to `False` along with `toolItemSetExpand` is useful to create an item that forces following items to the end of the toolbar.

Since: 2.4

# Properties

## draw

No description available in the introspection data.

constructSeparatorToolItemDraw :: (IsSeparatorToolItem o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getSeparatorToolItemDraw :: (MonadIO m, IsSeparatorToolItem o) => o -> m Bool Source #

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

    get separatorToolItem #draw

setSeparatorToolItemDraw :: (MonadIO m, IsSeparatorToolItem o) => o -> Bool -> m () Source #

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

    set separatorToolItem [ #draw := value ]