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.Arrow

Contents

- Exported types
- Methods
  - new
  - set
- Properties
  - arrowType
  - shadowType

Description

GtkArrow should be used to draw simple arrows that need to point in one of the four cardinal directions (up, down, left, or right). The style of the arrow can be one of shadow in, shadow out, etched in, or etched out. Note that these directions and style types may be amended in versions of GTK+ to come.

GtkArrow will fill any space alloted to it, but since it is inherited from `Misc`, it can be padded and/or aligned, to fill exactly the space the programmer desires.

Arrows are created with a call to `arrowNew`. The direction or style of an arrow can be changed after creation by using `arrowSet`.

GtkArrow has been deprecated; you can simply use a `Image` with a suitable icon name, such as “pan-down-symbolic“. When replacing GtkArrow by an image, pay attention to the fact that GtkArrow is doing automatic flipping between `GTK_ARROW_LEFT` and `GTK_ARROW_RIGHT`, depending on the text direction. To get the same effect with an image, use the icon names “pan-start-symbolic“ and “pan-end-symbolic“, which react to the text direction.

Synopsis

- newtype Arrow = Arrow (ManagedPtr Arrow)
- class (GObject o, IsDescendantOf Arrow o) => IsArrow o
- toArrow :: (MonadIO m, IsArrow o) => o -> m Arrow
- arrowNew :: (HasCallStack, MonadIO m) => ArrowType -> ShadowType -> m Arrow
- arrowSet :: (HasCallStack, MonadIO m, IsArrow a) => a -> ArrowType -> ShadowType -> m ()
- constructArrowArrowType :: (IsArrow o, MonadIO m) => ArrowType -> m (GValueConstruct o)
- getArrowArrowType :: (MonadIO m, IsArrow o) => o -> m ArrowType
- setArrowArrowType :: (MonadIO m, IsArrow o) => o -> ArrowType -> m ()
- constructArrowShadowType :: (IsArrow o, MonadIO m) => ShadowType -> m (GValueConstruct o)
- getArrowShadowType :: (MonadIO m, IsArrow o) => o -> m ShadowType
- setArrowShadowType :: (MonadIO m, IsArrow o) => o -> ShadowType -> m ()

# Exported types

newtype Arrow Source #

Memory-managed wrapper type.

Constructors

Arrow (ManagedPtr Arrow) |

#### Instances

Instances details

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

class (GObject o, IsDescendantOf Arrow o) => IsArrow o Source #

Type class for types which can be safely cast to `Arrow`, for instance with `toArrow`.

#### Instances

Instances details

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

toArrow :: (MonadIO m, IsArrow o) => o -> m Arrow Source #

Cast to `Arrow`, 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, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, childFocus, childNotify, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, 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, forceFloating, 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, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, runDispose, sendExpose, sendFocusChange, set, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetStateFlags, watchClosure.

#### Getters

getAccessible, getActionGroup, getAlignment, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getCanDefault, getCanFocus, getChildRequisition, getChildVisible, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPadding, getPangoContext, getParent, getParentWindow, getPath, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

#### Setters

setAccelPath, setAlignment, setAllocation, setAppPaintable, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setPadding, setParent, setParentWindow, setProperty, setRealized, setReceivesDefault, setRedrawOnAllocate, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

## new

arrowNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> ArrowType | `arrowType`: a valid `ArrowType`.
-> ShadowType | `shadowType`: a valid `ShadowType`.
-> m Arrow | Returns: the new `Arrow` widget.

Deprecated: (Since version 3.14)Use a `Image` with a suitable icon.

Creates a new `Arrow` widget.

## set

arrowSet Source #

Arguments

:: (HasCallStack, MonadIO m, IsArrow a) |
=> a | `arrow`: a widget of type `Arrow`.
-> ArrowType | `arrowType`: a valid `ArrowType`.
-> ShadowType | `shadowType`: a valid `ShadowType`.
-> m () |

Deprecated: (Since version 3.14)Use a `Image` with a suitable icon.

Sets the direction and style of the `Arrow`, `arrow`.

# Properties

## arrowType

No description available in the introspection data.

constructArrowArrowType :: (IsArrow o, MonadIO m) => ArrowType -> m (GValueConstruct o) Source #

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

getArrowArrowType :: (MonadIO m, IsArrow o) => o -> m ArrowType Source #

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

    get arrow #arrowType

setArrowArrowType :: (MonadIO m, IsArrow o) => o -> ArrowType -> m () Source #

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

    set arrow [ #arrowType := value ]

## shadowType

No description available in the introspection data.

constructArrowShadowType :: (IsArrow o, MonadIO m) => ShadowType -> m (GValueConstruct o) Source #

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

getArrowShadowType :: (MonadIO m, IsArrow o) => o -> m ShadowType Source #

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

    get arrow #shadowType

setArrowShadowType :: (MonadIO m, IsArrow o) => o -> ShadowType -> m () Source #

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

    set arrow [ #shadowType := value ]