HTk.Containers.Window

Basic types and classes concerning toplevel window resources.

Documentation

class GUIObject w => Window w where

Toplevel windows instantiate the class Window.

Methods

iconify :: w -> IO ()

deiconify :: w -> IO ()

withdraw :: w -> IO ()

putWinOnTop :: w -> IO ()

putWinAtBottom :: w -> IO ()

screen :: Display -> Config w

getScreen :: w -> IO Display

getClassName :: w -> IO String

getWindowState :: w -> IO WindowState

aspectRatio :: AspectRatio -> Config w

getAspectRatio :: w -> IO AspectRatio

positionFrom :: Whom -> Config w

getPositionFrom :: w -> IO Whom

sizeFrom :: Whom -> Config w

getSizeFrom :: w -> IO Whom

Instances

Window Toplevel

A toplevel widget is a window (with various configurations and actions concerning its stacking order, display status, screen, aspect ratio etc.).

Methods

iconify :: Toplevel -> IO ()

deiconify :: Toplevel -> IO ()

withdraw :: Toplevel -> IO ()

putWinOnTop :: Toplevel -> IO ()

putWinAtBottom :: Toplevel -> IO ()

screen :: Display -> Config Toplevel

getScreen :: Toplevel -> IO Display

getClassName :: Toplevel -> IO String

getWindowState :: Toplevel -> IO WindowState

aspectRatio :: AspectRatio -> Config Toplevel

getAspectRatio :: Toplevel -> IO AspectRatio

positionFrom :: Whom -> Config Toplevel

getPositionFrom :: Toplevel -> IO Whom

sizeFrom :: Whom -> Config Toplevel

getSizeFrom :: Toplevel -> IO Whom

Window HTk

The wish instance is associated with the main window (with various configurations and actions concerning its stacking order, display status, screen, aspect ratio etc.).

Methods

iconify :: HTk -> IO ()

deiconify :: HTk -> IO ()

withdraw :: HTk -> IO ()

putWinOnTop :: HTk -> IO ()

putWinAtBottom :: HTk -> IO ()

screen :: Display -> Config HTk

getScreen :: HTk -> IO Display

getClassName :: HTk -> IO String

getWindowState :: HTk -> IO WindowState

aspectRatio :: AspectRatio -> Config HTk

getAspectRatio :: HTk -> IO AspectRatio

positionFrom :: Whom -> Config HTk

getPositionFrom :: HTk -> IO Whom

sizeFrom :: Whom -> Config HTk

getSizeFrom :: HTk -> IO Whom

CItem c => Window (GenGUI c)

A GenGUI object is a window.

Methods

iconify :: GenGUI c -> IO ()

deiconify :: GenGUI c -> IO ()

withdraw :: GenGUI c -> IO ()

putWinOnTop :: GenGUI c -> IO ()

putWinAtBottom :: GenGUI c -> IO ()

screen :: Display -> Config (GenGUI c)

getScreen :: GenGUI c -> IO Display

getClassName :: GenGUI c -> IO String

getWindowState :: GenGUI c -> IO WindowState

aspectRatio :: AspectRatio -> Config (GenGUI c)

getAspectRatio :: GenGUI c -> IO AspectRatio

positionFrom :: Whom -> Config (GenGUI c)

getPositionFrom :: GenGUI c -> IO Whom

sizeFrom :: Whom -> Config (GenGUI c)

getSizeFrom :: GenGUI c -> IO Whom

type Display = String

maxSize :: Window w => Size -> Config w

Constraints the maximum size of the window.

getMaxSize :: Window w => w -> IO Size

Gets the maximum size of the window.

minSize :: Window w => Size -> Config w

Constraints the minimum size of the window.

getMinSize :: Window w => w -> IO Size

Gets the minimum size of the window.

raiseWin

Arguments

:: (Window w1, Window w2)

=> w1

the first window.

-> w2

the second window.

-> IO ()

None.

Puts the first given window just above the second given window in the stacking order.

lowerWin

Arguments

:: (Window w1, Window w2)

=> w1

the first window.

-> w2

the second window.

-> IO ()

None.

Puts the first given window just below the second given window in the stacking order.

data WindowState

The WindowState datatype.

Constructors

Deiconified

Iconified

Withdrawn

Instances

Enum WindowState

Methods

succ :: WindowState -> WindowState

pred :: WindowState -> WindowState

toEnum :: Int -> WindowState

fromEnum :: WindowState -> Int

enumFrom :: WindowState -> [WindowState]

enumFromThen :: WindowState -> WindowState -> [WindowState]

enumFromTo :: WindowState -> WindowState -> [WindowState]

enumFromThenTo :: WindowState -> WindowState -> WindowState -> [WindowState]

Eq WindowState

Methods

(==) :: WindowState -> WindowState -> Bool

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

Ord WindowState

Methods

compare :: WindowState -> WindowState -> Ordering

(<) :: WindowState -> WindowState -> Bool

(<=) :: WindowState -> WindowState -> Bool

(>) :: WindowState -> WindowState -> Bool

(>=) :: WindowState -> WindowState -> Bool

max :: WindowState -> WindowState -> WindowState

min :: WindowState -> WindowState -> WindowState

Read WindowState

Internal.

Methods

readsPrec :: Int -> ReadS WindowState

readList :: ReadS [WindowState]

readPrec :: ReadPrec WindowState

readListPrec :: ReadPrec [WindowState]

Show WindowState

Internal.

Methods

showsPrec :: Int -> WindowState -> ShowS

show :: WindowState -> String

showList :: [WindowState] -> ShowS

GUIValue WindowState

Internal.

Methods

cdefault :: WindowState

toGUIValue :: WindowState -> GUIVALUE

maybeGUIValue :: GUIVALUE -> Maybe WindowState

fromGUIValue :: GUIVALUE -> WindowState

data AspectRatio

The AspectRatio datatype.

Instances

Eq AspectRatio

Methods

(==) :: AspectRatio -> AspectRatio -> Bool

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

Read AspectRatio

Internal.

Methods

readsPrec :: Int -> ReadS AspectRatio

readList :: ReadS [AspectRatio]

readPrec :: ReadPrec AspectRatio

readListPrec :: ReadPrec [AspectRatio]

Show AspectRatio

Internal.

Methods

showsPrec :: Int -> AspectRatio -> ShowS

show :: AspectRatio -> String

showList :: [AspectRatio] -> ShowS

GUIValue AspectRatio

Internal.

Methods

cdefault :: AspectRatio

toGUIValue :: AspectRatio -> GUIVALUE

maybeGUIValue :: GUIVALUE -> Maybe AspectRatio

fromGUIValue :: GUIVALUE -> AspectRatio

data Whom

The Whom datatype.

Instances

Enum Whom

Methods

succ :: Whom -> Whom

pred :: Whom -> Whom

toEnum :: Int -> Whom

fromEnum :: Whom -> Int

enumFrom :: Whom -> [Whom]

enumFromThen :: Whom -> Whom -> [Whom]

enumFromTo :: Whom -> Whom -> [Whom]

enumFromThenTo :: Whom -> Whom -> Whom -> [Whom]

Eq Whom

Methods

(==) :: Whom -> Whom -> Bool

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

Ord Whom

Methods

compare :: Whom -> Whom -> Ordering

(<) :: Whom -> Whom -> Bool

(<=) :: Whom -> Whom -> Bool

(>) :: Whom -> Whom -> Bool

(>=) :: Whom -> Whom -> Bool

max :: Whom -> Whom -> Whom

min :: Whom -> Whom -> Whom

Read Whom

Internal.

Methods

readsPrec :: Int -> ReadS Whom

readList :: ReadS [Whom]

readPrec :: ReadPrec Whom

readListPrec :: ReadPrec [Whom]

Show Whom

Internal.

Methods

showsPrec :: Int -> Whom -> ShowS

show :: Whom -> String

showList :: [Whom] -> ShowS

GUIValue Whom

Internal.

Methods

cdefault :: Whom

toGUIValue :: Whom -> GUIVALUE

maybeGUIValue :: GUIVALUE -> Maybe Whom

fromGUIValue :: GUIVALUE -> Whom

isWMConfig :: ConfigID -> Bool

Internal.

Orphan instances

Window w => HasGeometry w

A window has a configureable size and anchor position (geometry).

Methods

geometry :: Geometry -> Config w

getGeometry :: w -> IO Geometry

(Window w, GUIObject w) => HasPosition w

A window has a position on the associated screen.

Methods

position :: Position -> Config w

getPosition :: w -> IO Position

(Window w, GUIObject w) => HasSize w

A window has a configureable size.

Methods

width :: Distance -> Config w

getWidth :: w -> IO Distance

height :: Distance -> Config w

getHeight :: w -> IO Distance

size :: Size -> Config w

getSize :: w -> IO Size

(Window w, GUIValue v) => HasText w v

A window has a title.

Methods

text :: v -> Config w

getText :: w -> IO v