HTk.Canvasitems.CanvasItem

The module CanvasItem exports basic classes and general functionality on canvas items.

Documentation

data Canvas

The Canvas datatype.

Instances

Eq Canvas

Methods

(==) :: Canvas -> Canvas -> Bool

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

Destroyable Canvas

A canvas widget can be destroyed.

Methods

destroy :: Canvas -> IO ()

Synchronized Canvas

You can synchronize on a canvas object (in JAVA style).

Methods

synchronize :: Canvas -> IO b -> IO b

GUIObject Canvas

Internal.

Methods

toGUIObject :: Canvas -> GUIOBJECT

cname :: Canvas -> String

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

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

HasEnable Canvas

A canvas widget is a stateful widget, it can be enabled or disabled.

Methods

state :: State -> Config Canvas

getState :: Canvas -> IO State

disable :: Config Canvas

enable :: Config Canvas

isEnabled :: Canvas -> IO Bool

HasBorder Canvas

A canvas widget has a configureable border.

Methods

borderwidth :: Distance -> Config Canvas

getBorderwidth :: Canvas -> IO Distance

relief :: Relief -> Config Canvas

getRelief :: Canvas -> IO Relief

HasSize Canvas

You can specify the size of a canvas.

Methods

width :: Distance -> Config Canvas

getWidth :: Canvas -> IO Distance

height :: Distance -> Config Canvas

getHeight :: Canvas -> IO Distance

size :: Size -> Config Canvas

getSize :: Canvas -> IO Size

HasColour Canvas

A canvas widget has a foreground and background colour.

Methods

legalColourID :: Canvas -> ConfigID -> Bool

setColour :: Canvas -> ConfigID -> Colour -> IO Canvas

getColour :: Canvas -> ConfigID -> IO Colour

HasTooltip Canvas

A canvas can have a tooltip (only displayed if you are using tixwish).

Methods

tooltip :: String -> Canvas -> IO Canvas

destroyTooltip :: Canvas -> IO ()

Widget Canvas

A canvas widget has standard widget properties (concerning focus, cursor).

Methods

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

getCursor :: Canvas -> IO Cursor

takeFocus :: Bool -> Config Canvas

getTakeFocus :: Canvas -> IO Bool

Container Canvas

A canvas is also a container for widgets, because it can contain widgets in embedded windows.

HasPostscript Canvas

The contents of a canvas is printable.

Methods

postscript :: Canvas -> [CreationConfig PostScript] -> IO ()

HasScroller Canvas

A canvas is a scrollable widget.

Methods

isWfOrientation :: Canvas -> Orientation -> Bool

scrollbar :: Orientation -> ScrollBar -> Config Canvas

moveto :: Orientation -> Canvas -> Fraction -> IO ()

scroll :: Orientation -> Canvas -> Int -> ScrollUnit -> IO ()

view :: Orientation -> Canvas -> IO (Fraction, Fraction)

GUIObject c => HasBBox Canvas c

You can request the bounding box size of a canvas item (use a canvas tag for the bounding box of a set of items).

Methods

bbox :: Canvas -> c -> IO (Maybe (Distance, Distance, Distance, Distance))

class HasCoords w where

You can set the coords (position / size) of a canvas item on the parent canvas.

Minimal complete definition

coord, getCoord

Methods

coord :: Coord -> Config w

getCoord :: w -> IO Coord

Instances

CanvasItem w => HasCoords w

Any canvas item has coords on the parent canvas.

Methods

coord :: Coord -> Config w

getCoord :: w -> IO Coord

class GUIObject w => CanvasItem w

Any canvas item is an instance of the abstract class CanvasItem.

Instances

CanvasItem CanvasTag

A canvas tag is a canvas item (any canvas item is an instance of the abstract class CanvasItem).

CanvasItem EmbeddedCanvasWin

An embedded canvas window is a canvas item (any canvas item is an instance of the abstract class CanvasItem).

CanvasItem ImageItem

An image item is a canvas item (any canvas item is an instance of the abstract class CanvasItem).

CanvasItem Line

A line item is a canvas item (any canvas item is an instance of the abstract class CanvasItem).

CanvasItem Oval

An oval item is a canvas item (any canvas item is an instance of the abstract class CanvasItem).

CanvasItem Polygon

A polygon item is a canvas item (any canvas item is an instance of the abstract class CanvasItem).

CanvasItem Rectangle

A rectangle item is a canvas item (any canvas item is an instance of the abstract class CanvasItem).

CanvasItem TextItem

A text item is a canvas item (any canvas item is an instance of the abstract class CanvasItem).

CanvasItem BitMapItem

A bitmap item is a canvas item (any canvas item is an instance of the abstract class CanvasItem).

CanvasItem Arc

An arc is a canvas item (any canvas item is an instance of the abstract class CanvasItem).

class CanvasItem w => FilledCanvasItem w where

Any canvas item has a filling, outline, outline width and stipple configuration.

Methods

filling :: ColourDesignator c => c -> Config w

getFilling :: w -> IO Colour

outline :: ColourDesignator c => c -> Config w

getOutline :: w -> IO Colour

stipple :: BitMapHandle -> Config w

getStipple :: w -> IO BitMapHandle

outlinewidth :: Distance -> Config w

getOutlineWidth :: w -> IO Distance

Instances

FilledCanvasItem Line

A line item has filling, outline width and stipple configurations.

Methods

filling :: ColourDesignator c => c -> Config Line

getFilling :: Line -> IO Colour

outline :: ColourDesignator c => c -> Config Line

getOutline :: Line -> IO Colour

stipple :: BitMapHandle -> Config Line

getStipple :: Line -> IO BitMapHandle

outlinewidth :: Distance -> Config Line

getOutlineWidth :: Line -> IO Distance

FilledCanvasItem Oval

An oval item is a filled canvas item (it has filling, outline, outline width, and stipple configurations).

Methods

filling :: ColourDesignator c => c -> Config Oval

getFilling :: Oval -> IO Colour

outline :: ColourDesignator c => c -> Config Oval

getOutline :: Oval -> IO Colour

stipple :: BitMapHandle -> Config Oval

getStipple :: Oval -> IO BitMapHandle

outlinewidth :: Distance -> Config Oval

getOutlineWidth :: Oval -> IO Distance

FilledCanvasItem Polygon

A polygon item is a filled canvas item (it has filling, outline, outline width, and stipple configurations).

Methods

filling :: ColourDesignator c => c -> Config Polygon

getFilling :: Polygon -> IO Colour

outline :: ColourDesignator c => c -> Config Polygon

getOutline :: Polygon -> IO Colour

stipple :: BitMapHandle -> Config Polygon

getStipple :: Polygon -> IO BitMapHandle

outlinewidth :: Distance -> Config Polygon

getOutlineWidth :: Polygon -> IO Distance

FilledCanvasItem Rectangle

A rectangle item is a filled canvas item (it has filling, outline, outline width, and stipple configurations).

Methods

filling :: ColourDesignator c => c -> Config Rectangle

getFilling :: Rectangle -> IO Colour

outline :: ColourDesignator c => c -> Config Rectangle

getOutline :: Rectangle -> IO Colour

stipple :: BitMapHandle -> Config Rectangle

getStipple :: Rectangle -> IO BitMapHandle

outlinewidth :: Distance -> Config Rectangle

getOutlineWidth :: Rectangle -> IO Distance

FilledCanvasItem TextItem

An oval item is a filled canvas item (it has filling, outline width, and stipple configurations).

Methods

filling :: ColourDesignator c => c -> Config TextItem

getFilling :: TextItem -> IO Colour

outline :: ColourDesignator c => c -> Config TextItem

getOutline :: TextItem -> IO Colour

stipple :: BitMapHandle -> Config TextItem

getStipple :: TextItem -> IO BitMapHandle

outlinewidth :: Distance -> Config TextItem

getOutlineWidth :: TextItem -> IO Distance

FilledCanvasItem BitMapItem

A bitmap item is a filled canvas item (it has filling, outline, outline width, and stipple configurations).

Methods

filling :: ColourDesignator c => c -> Config BitMapItem

getFilling :: BitMapItem -> IO Colour

outline :: ColourDesignator c => c -> Config BitMapItem

getOutline :: BitMapItem -> IO Colour

stipple :: BitMapHandle -> Config BitMapItem

getStipple :: BitMapItem -> IO BitMapHandle

outlinewidth :: Distance -> Config BitMapItem

getOutlineWidth :: BitMapItem -> IO Distance

FilledCanvasItem Arc

An arc is a filled canvas item (it has filling, outline, outline width, and stipple configurations).

Methods

filling :: ColourDesignator c => c -> Config Arc

getFilling :: Arc -> IO Colour

outline :: ColourDesignator c => c -> Config Arc

getOutline :: Arc -> IO Colour

stipple :: BitMapHandle -> Config Arc

getStipple :: Arc -> IO BitMapHandle

outlinewidth :: Distance -> Config Arc

getOutlineWidth :: Arc -> IO Distance

class CanvasItem w => SegmentedCanvasItem w where

Segmented canvas items have a splinesteps and smooth configuration.

Methods

splinesteps :: Int -> Config w

getSplinesteps :: w -> IO Int

smooth :: Bool -> Config w

getSmooth :: w -> IO Bool

Instances

SegmentedCanvasItem Line

A line is a segmented canvas item. It has a splinesteps and smooth configuration.

Methods

splinesteps :: Int -> Config Line

getSplinesteps :: Line -> IO Int

smooth :: Bool -> Config Line

getSmooth :: Line -> IO Bool

SegmentedCanvasItem Polygon

A line is a segmented canvas item. It has a splinesteps and smooth configuration.

Methods

splinesteps :: Int -> Config Polygon

getSplinesteps :: Polygon -> IO Int

smooth :: Bool -> Config Polygon

getSmooth :: Polygon -> IO Bool

moveItem :: (Synchronized w, CanvasItem w) => w -> Distance -> Distance -> IO ()

Moves a canvas item horizontally and vertically by the given distances.

scaleItem :: (Synchronized w, CanvasItem w) => w -> Distance -> Distance -> Double -> Double -> IO ()

Scales a canvas item horizontally and vertically by the given distances.

raiseItem :: (CanvasItem ci, CanvasItem w) => ci -> w -> IO ()

Moves an item above another item in the display list.

lowerItem :: (CanvasItem ci, CanvasItem w) => ci -> w -> IO ()

Moves an item below another item in the display list.

putItemOnTop :: CanvasItem w => w -> IO ()

Puts an item on top of the display list.

putItemAtBottom :: CanvasItem ci => ci -> IO ()

Puts an items at bottom of the display list.

itemsNotOnSameCanvas :: IOError

Exception raised by CanasItem.onSameCanvas.

declVar :: CanvasTagOrID -> TclScript

Retrieve all tagnames in a complex tag expression and declare them global in form of a TclScript

declVarList :: CanvasTagOrID -> TclCmd

Retrieve all tagnames in a complex tag expression and declare them global in form of a TclCmd