| 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.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
- newtype Image = Image (ManagedPtr Image)
- class (ManagedPtrNewtype o, IsDescendantOf Image o) => IsImage o
- type family ResolveImageMethod (t :: Symbol) o where ...
- data ImageGetImageDescriptionMethodInfo
- imageGetImageDescription :: (HasCallStack, MonadIO m, IsImage a) => a -> m Text
- data ImageGetImageLocaleMethodInfo
- imageGetImageLocale :: (HasCallStack, MonadIO m, IsImage a) => a -> m (Maybe Text)
- data ImageGetImagePositionMethodInfo
- imageGetImagePosition :: (HasCallStack, MonadIO m, IsImage a) => a -> CoordType -> m (Int32, Int32)
- data ImageGetImageSizeMethodInfo
- imageGetImageSize :: (HasCallStack, MonadIO m, IsImage a) => a -> m (Int32, Int32)
- data ImageSetImageDescriptionMethodInfo
- imageSetImageDescription :: (HasCallStack, MonadIO m, IsImage a) => a -> Text -> m Bool
Exported types
Memory-managed wrapper type.
Constructors
| Image (ManagedPtr Image) |
Instances
| Eq Image Source # | |
| BoxedPtr Image Source # | |
Defined in GI.Atk.Interfaces.Image | |
| ManagedPtrNewtype Image Source # | |
Defined in GI.Atk.Interfaces.Image Methods toManagedPtr :: Image -> ManagedPtr Image # | |
| (info ~ ResolveImageMethod t Image, OverloadedMethod info Image p, HasField t Image p) => HasField (t :: Symbol) Image (p :: Type) Source # | |
Defined in GI.Atk.Interfaces.Image | |
| (info ~ ResolveImageMethod t Image, OverloadedMethodInfo info Image) => IsLabel t (MethodProxy info Image) Source # | |
Defined in GI.Atk.Interfaces.Image Methods fromLabel :: MethodProxy info Image # | |
| (info ~ ResolveImageMethod t Image, OverloadedMethod info Image p) => IsLabel t (Image -> p) Source # | |
Defined in GI.Atk.Interfaces.Image | |
| type SignalList Image Source # | |
Defined in GI.Atk.Interfaces.Image | |
class (ManagedPtrNewtype o, IsDescendantOf Image o) => IsImage o Source #
Type class for types which implement Image.
Instances
| (ManagedPtrNewtype o, IsDescendantOf Image o) => IsImage o Source # | |
Defined in GI.Atk.Interfaces.Image | |
Methods
Click to display all available methods, including inherited ones
type family ResolveImageMethod (t :: Symbol) o where ... Source #
Equations
| ResolveImageMethod "getImageDescription" o = ImageGetImageDescriptionMethodInfo | |
| ResolveImageMethod "getImageLocale" o = ImageGetImageLocaleMethodInfo | |
| ResolveImageMethod "getImagePosition" o = ImageGetImagePositionMethodInfo | |
| ResolveImageMethod "getImageSize" o = ImageGetImageSizeMethodInfo | |
| ResolveImageMethod "setImageDescription" o = ImageSetImageDescriptionMethodInfo | |
| ResolveImageMethod l o = MethodResolutionFailed l o :: Type |
getImageDescription
data ImageGetImageDescriptionMethodInfo Source #
Instances
| (signature ~ m Text, MonadIO m, IsImage a) => OverloadedMethod ImageGetImageDescriptionMethodInfo a signature Source # | |
Defined in GI.Atk.Interfaces.Image Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ImageGetImageDescriptionMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Interfaces.Image Methods | |
imageGetImageDescription Source #
Arguments
| :: (HasCallStack, MonadIO m, IsImage a) | |
| => a |
|
| -> m Text | Returns: a string representing the image description |
Get a textual description of this image.
getImageLocale
data ImageGetImageLocaleMethodInfo Source #
Instances
| (signature ~ m (Maybe Text), MonadIO m, IsImage a) => OverloadedMethod ImageGetImageLocaleMethodInfo a signature Source # | |
Defined in GI.Atk.Interfaces.Image Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ImageGetImageLocaleMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Interfaces.Image Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsImage a) | |
| => a |
|
| -> m (Maybe Text) | Returns: a string corresponding to the POSIX
|
Retrieves the locale identifier associated to the Image.
Since: 1.12
getImagePosition
data ImageGetImagePositionMethodInfo Source #
Instances
| (signature ~ (CoordType -> m (Int32, Int32)), MonadIO m, IsImage a) => OverloadedMethod ImageGetImagePositionMethodInfo a signature Source # | |
Defined in GI.Atk.Interfaces.Image Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ImageGetImagePositionMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Interfaces.Image Methods | |
imageGetImagePosition Source #
Arguments
| :: (HasCallStack, MonadIO m, IsImage a) | |
| => a |
|
| -> CoordType |
|
| -> 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
| (signature ~ m (Int32, Int32), MonadIO m, IsImage a) => OverloadedMethod ImageGetImageSizeMethodInfo a signature Source # | |
Defined in GI.Atk.Interfaces.Image Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ImageGetImageSizeMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Interfaces.Image Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsImage a) | |
| => a |
|
| -> 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
data ImageSetImageDescriptionMethodInfo Source #
Instances
| (signature ~ (Text -> m Bool), MonadIO m, IsImage a) => OverloadedMethod ImageSetImageDescriptionMethodInfo a signature Source # | |
Defined in GI.Atk.Interfaces.Image Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ImageSetImageDescriptionMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Interfaces.Image Methods | |
imageSetImageDescription Source #
Arguments
| :: (HasCallStack, MonadIO m, IsImage a) | |
| => a |
|
| -> Text |
|
| -> m Bool | Returns: boolean TRUE, or FALSE if operation could not be completed. |
Sets the textual description for this image.