gi-atk
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Atk.Interfaces.Image

Description

The ATK Interface implemented by components which expose image or pixmap content on-screen.

Image should be implemented by Object subtypes on behalf of components which display image/pixmap information onscreen, and which provide information (other than just widget borders, etc.) via that image content. For instance, icons, buttons with icons, toolbar elements, and image viewing panes typically should implement Image.

Image primarily provides two types of information: coordinate information (useful for screen review mode of screenreaders, and for use by onscreen magnifiers), and descriptive information. The descriptive information is provided for alternative, text-only presentation of the most significant information present in the image.

Synopsis

Exported types

newtype Image Source #

Memory-managed wrapper type.

Constructors

Image (ManagedPtr Image) 

Instances

Instances details
Eq Image Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

Methods

(==) :: Image -> Image -> Bool #

(/=) :: Image -> Image -> Bool #

BoxedPtr Image Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

ManagedPtrNewtype Image Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

(info ~ ResolveImageMethod t Image, OverloadedMethod info Image p, HasField t Image p) => HasField (t :: Symbol) Image (p :: Type) Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

Methods

getField :: Image -> p #

(info ~ ResolveImageMethod t Image, OverloadedMethodInfo info Image) => IsLabel t (MethodProxy info Image) Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

Methods

fromLabel :: MethodProxy info Image #

(info ~ ResolveImageMethod t Image, OverloadedMethod info Image p) => IsLabel t (Image -> p) Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

Methods

fromLabel :: Image -> p #

type SignalList Image Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

class (ManagedPtrNewtype o, IsDescendantOf Image o) => IsImage o Source #

Type class for types which implement Image.

Instances

Instances details
(ManagedPtrNewtype o, IsDescendantOf Image o) => IsImage o Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

Methods

Click to display all available methods, including inherited ones

Expand

Methods

None.

Getters

getImageDescription, getImageLocale, getImagePosition, getImageSize.

Setters

setImageDescription.

getImageDescription

imageGetImageDescription Source #

Arguments

:: (HasCallStack, MonadIO m, IsImage a) 
=> a

image: a Object instance that implements AtkImageIface

-> m Text

Returns: a string representing the image description

Get a textual description of this image.

getImageLocale

data ImageGetImageLocaleMethodInfo Source #

Instances

Instances details
(signature ~ m (Maybe Text), MonadIO m, IsImage a) => OverloadedMethod ImageGetImageLocaleMethodInfo a signature Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo ImageGetImageLocaleMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

imageGetImageLocale Source #

Arguments

:: (HasCallStack, MonadIO m, IsImage a) 
=> a

image: An Image

-> m (Maybe Text)

Returns: a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or Nothing if the image does not specify a locale.

Retrieves the locale identifier associated to the Image.

Since: 1.12

getImagePosition

data ImageGetImagePositionMethodInfo Source #

Instances

Instances details
(signature ~ (CoordType -> m (Int32, Int32)), MonadIO m, IsImage a) => OverloadedMethod ImageGetImagePositionMethodInfo a signature Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo ImageGetImagePositionMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

imageGetImagePosition Source #

Arguments

:: (HasCallStack, MonadIO m, IsImage a) 
=> a

image: a Object instance that implements AtkImageIface

-> CoordType

coordType: specifies whether the coordinates are relative to the screen or to the components top level window

-> m (Int32, Int32) 

Gets the position of the image in the form of a point specifying the images top-left corner.

If the position can not be obtained (e.g. missing support), x and y are set to -1.

getImageSize

data ImageGetImageSizeMethodInfo Source #

Instances

Instances details
(signature ~ m (Int32, Int32), MonadIO m, IsImage a) => OverloadedMethod ImageGetImageSizeMethodInfo a signature Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo ImageGetImageSizeMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.Atk.Interfaces.Image

imageGetImageSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsImage a) 
=> a

image: a Object instance that implements AtkImageIface

-> m (Int32, Int32) 

Get the width and height in pixels for the specified image. The values of width and height are returned as -1 if the values cannot be obtained (for instance, if the object is not onscreen).

If the size can not be obtained (e.g. missing support), x and y are set to -1.

setImageDescription

imageSetImageDescription Source #

Arguments

:: (HasCallStack, MonadIO m, IsImage a) 
=> a

image: a Object instance that implements AtkImageIface

-> Text

description: a string description to set for image

-> m Bool

Returns: boolean TRUE, or FALSE if operation could not be completed.

Sets the textual description for this image.