HTk.Components.Image

This module provides access to image resources from files or base64 encoded strings.

Documentation

class GUIObject w => HasPhoto w where

Image containers instantiate the class HasPhoto.

Methods

photo :: Image -> Config w

getPhoto :: w -> IO (Maybe Image)

Instances

HasPhoto MenuCascade

A menu cascade item can contain an image (instead of text or a bitmap).

Methods

photo :: Image -> Config MenuCascade

getPhoto :: MenuCascade -> IO (Maybe Image)

HasPhoto MenuCheckButton

A menu checkbutton can contain an image (instead of text or a bitmap).

Methods

photo :: Image -> Config MenuCheckButton

getPhoto :: MenuCheckButton -> IO (Maybe Image)

HasPhoto MenuCommand

A menu command can contain an image (instead of text or a bitmap).

Methods

photo :: Image -> Config MenuCommand

getPhoto :: MenuCommand -> IO (Maybe Image)

HasPhoto MenuRadioButton

You can specify the size of a menu radiobutton.

Methods

photo :: Image -> Config MenuRadioButton

getPhoto :: MenuRadioButton -> IO (Maybe Image)

HasPhoto Button

A button can contain an image.

Methods

photo :: Image -> Config Button

getPhoto :: Button -> IO (Maybe Image)

HasPhoto Label

A label can contain an image.

Methods

photo :: Image -> Config Label

getPhoto :: Label -> IO (Maybe Image)

HasPhoto MenuButton

A menubutton can contain an image.

Methods

photo :: Image -> Config MenuButton

getPhoto :: MenuButton -> IO (Maybe Image)

HasPhoto ImageItem

An image item is a container for an image object.

Methods

photo :: Image -> Config ImageItem

getPhoto :: ImageItem -> IO (Maybe Image)

(HasIndicator w, SelectButton w) => HasPhoto (Indicator w)

You can specify specify an alternate image for the selector of menu checkbuttons and menu radiobuttons.

Methods

photo :: Image -> Config (Indicator w)

getPhoto :: Indicator w -> IO (Maybe Image)

HasPhoto (CheckButton a)

A checkbutton can contain an image.

Methods

photo :: Image -> Config (CheckButton a)

getPhoto :: CheckButton a -> IO (Maybe Image)

HasPhoto (RadioButton a)

A radiobutton can contain an image.

Methods

photo :: Image -> Config (RadioButton a)

getPhoto :: RadioButton a -> IO (Maybe Image)

HasPhoto (Dialog a)

A dialog can have an image

Methods

photo :: Image -> Config (Dialog a)

getPhoto :: Dialog a -> IO (Maybe Image)

data Image

The Image datatype.

Instances

Eq Image

Methods

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

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

Destroyable Image

An image object can be destroyed.

Methods

destroy :: Image -> IO ()

Synchronized Image

You can synchronize on an image object.

Methods

synchronize :: Image -> IO b -> IO b

GUIObject Image

Internal.

Methods

toGUIObject :: Image -> GUIOBJECT

cname :: Image -> String

cset :: GUIValue a => Image -> ConfigID -> a -> IO Image

cget :: GUIValue a => Image -> ConfigID -> IO a

HasFile Image

Images can be read from files.

Methods

filename :: String -> Config Image

getFileName :: Image -> IO String

HasBorder Image

An image object has a configureable border (if implicitely displayed inside a label widget).

Methods

borderwidth :: Distance -> Config Image

getBorderwidth :: Image -> IO Distance

relief :: Relief -> Config Image

getRelief :: Image -> IO Relief

HasSize Image

You can specify the size of the containing label, if the image is implicitely displayed inside a label widget.

Methods

width :: Distance -> Config Image

getWidth :: Image -> IO Distance

height :: Distance -> Config Image

getHeight :: Image -> IO Distance

size :: Size -> Config Image

getSize :: Image -> IO Size

HasColour Image

An image object has a configureable foreground and background colour (if implicitely displayed inside a label widget).

Methods

legalColourID :: Image -> ConfigID -> Bool

setColour :: Image -> ConfigID -> Colour -> IO Image

getColour :: Image -> ConfigID -> IO Colour

Widget Image

An image object has standard widget properties (concerning focus, cursor / if implicitely displayed inside a label widget).

Methods

cursor :: CursorDesignator ch => ch -> Config Image

getCursor :: Image -> IO Cursor

takeFocus :: Bool -> Config Image

getTakeFocus :: Image -> IO Bool

FormLabel Image

Methods

formLabel :: Frame -> Image -> IO (IO ())

newImage

Arguments

:: [Config Image]

the list of configuration options for this image object.

-> IO Image

An image object.

Constructs a new image object and returns a handler. The image object can be packed like a widget, then it is implicitely displayed inside a label widget.

intToImage :: Int -> IO (Maybe Image)

Internal.

imageToInt :: Image -> IO Int

Internal.

data Format

The Format datatype - represents the format of a base64 encoded image (see Image.imgData).

Constructors

GIF

PPM

PGM

imgData :: Format -> String -> Config Image

Sets the image data from a base64 encoded string.

imgGamma :: Double -> Config Image

The gamma correction factor. Values less than one darken the image, values greater than one brighten up the image.

imgPalette :: PaletteSpec p => p -> Config Image