Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Structs.Border

Contents

Exported types
Methods
- copy
- free
- new
Properties

Description

A struct that specifies a border around a rectangular area that can be of different width on each side.

Synopsis

newtype Border = Border (ManagedPtr Border)
newZeroBorder :: MonadIO m => m Border
noBorder :: Maybe Border
borderCopy :: (HasCallStack, MonadIO m) => Border -> m Border
borderFree :: (HasCallStack, MonadIO m) => Border -> m ()
borderNew :: (HasCallStack, MonadIO m) => m Border
getBorderBottom :: MonadIO m => Border -> m Int16
setBorderBottom :: MonadIO m => Border -> Int16 -> m ()
getBorderLeft :: MonadIO m => Border -> m Int16
setBorderLeft :: MonadIO m => Border -> Int16 -> m ()
getBorderRight :: MonadIO m => Border -> m Int16
setBorderRight :: MonadIO m => Border -> Int16 -> m ()
getBorderTop :: MonadIO m => Border -> m Int16
setBorderTop :: MonadIO m => Border -> Int16 -> m ()

Exported types

newtype Border Source #

Memory-managed wrapper type.

Constructors

Border (ManagedPtr Border)

Instances

BoxedObject Border Source #
Instance details Defined in GI.Gtk.Structs.Border Methods boxedType :: Border -> IO GType #
tag ~ AttrSet => Constructible Border tag Source #
Instance details Defined in GI.Gtk.Structs.Border Methods new :: MonadIO m => (ManagedPtr Border -> Border) -> [AttrOp Border tag] -> m Border #

newZeroBorder :: MonadIO m => m Border Source #

Construct a Border struct initialized to zero.

noBorder :: Maybe Border Source #

A convenience alias for Nothing :: Maybe Border.

Methods

copy

borderCopy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Border	`border_`: a `Border`-struct
-> m Border	Returns: a copy of `border_`.

Copies a Border-struct.

free

borderFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Border	`border_`: a `Border`-struct
-> m ()

Frees a Border-struct.

new

borderNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m Border	Returns: a newly allocated `Border`-struct. Free with `borderFree`

Allocates a new Border-struct and initializes its elements to zero.

Since: 2.14

Properties

bottom

The width of the bottom border

getBorderBottom :: MonadIO m => Border -> m Int16 Source #

Get the value of the “bottom” field. When overloading is enabled, this is equivalent to

get border #bottom

setBorderBottom :: MonadIO m => Border -> Int16 -> m () Source #

Set the value of the “bottom” field. When overloading is enabled, this is equivalent to

set border [ #bottom := value ]

left

The width of the left border

getBorderLeft :: MonadIO m => Border -> m Int16 Source #

Get the value of the “left” field. When overloading is enabled, this is equivalent to

get border #left

setBorderLeft :: MonadIO m => Border -> Int16 -> m () Source #

Set the value of the “left” field. When overloading is enabled, this is equivalent to

set border [ #left := value ]

right

The width of the right border

getBorderRight :: MonadIO m => Border -> m Int16 Source #

Get the value of the “right” field. When overloading is enabled, this is equivalent to

get border #right

setBorderRight :: MonadIO m => Border -> Int16 -> m () Source #

Set the value of the “right” field. When overloading is enabled, this is equivalent to

set border [ #right := value ]

top

The width of the top border

getBorderTop :: MonadIO m => Border -> m Int16 Source #

Get the value of the “top” field. When overloading is enabled, this is equivalent to

get border #top

setBorderTop :: MonadIO m => Border -> Int16 -> m () Source #

Set the value of the “top” field. When overloading is enabled, this is equivalent to

set border [ #top := value ]