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 |
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.
- newtype Image = Image (ManagedPtr Image)
- noImage :: Maybe Image
- class ManagedPtrNewtype a => IsImage a
- 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
Methods
getImageDescription
data ImageGetImageDescriptionMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsImage a) => MethodInfo * ImageGetImageDescriptionMethodInfo a signature Source # | |
imageGetImageDescription Source #
:: (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 #
((~) * signature (m (Maybe Text)), MonadIO m, IsImage a) => MethodInfo * ImageGetImageLocaleMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsImage a) | |
=> a |
|
-> m (Maybe Text) | Returns: a string corresponding to the POSIX
LC_MESSAGES locale used by the image description, or |
No description available in the introspection data.
Since: 1.12
getImagePosition
imageGetImagePosition Source #
:: (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.
getImageSize
data ImageGetImageSizeMethodInfo Source #
((~) * signature (m (Int32, Int32)), MonadIO m, IsImage a) => MethodInfo * ImageGetImageSizeMethodInfo a signature Source # | |
:: (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).
setImageDescription
data ImageSetImageDescriptionMethodInfo Source #
((~) * signature (Text -> m Bool), MonadIO m, IsImage a) => MethodInfo * ImageSetImageDescriptionMethodInfo a signature Source # | |
imageSetImageDescription Source #
:: (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.