wxcore-0.92.3.0: wxHaskell core

Copyright(c) Daan Leijen 2003
LicensewxWindows
Maintainerwxhaskell-devel@lists.sourceforge.net
Stabilityprovisional
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Graphics.UI.WXCore.Types

Contents

Description

Basic types and operations.

Synopsis

Objects

(#) :: obj -> (obj -> a) -> a infix 5 Source #

Reverse application, i.e. x # f = f x. Useful for an object oriented style of programming.

(frame # frameSetTitle) "hi"

data Object a Source #

An Object a is a pointer to an object of type a. The a parameter is used to encode the inheritance relation. When the type parameter is unit (), it denotes an object of exactly that class, when the parameter is a type variable a, it specifies an object that is at least an instance of that class. For example in wxWidgets, we have the following class hierarchy:

EvtHandler
  |- Window
       |- Frame
       |- Control
           |- Button
           |- Radiobox

In wxHaskell, all the creation functions will return objects of exactly that class and use the () type:

frameCreate :: Window a -> ... -> IO (Frame ())
buttonCreate :: Window a -> ... -> IO (Button ())
...

In contrast, all the this (or self) pointers of methods can take objects of any instance of that class and have a type variable, for example:

windowSetClientSize :: Window a -> Size -> IO ()
controlSetLabel     :: Control a -> String -> IO ()
buttonSetDefault    :: Button a -> IO ()

This means that we can use windowSetClientSize on any window, including buttons and frames, but we can only use controlSetLabel on controls, not including frames.

In wxHaskell, this works since a Frame () is actually a type synonym for Window (CFrame ()) (where CFrame is an abstract data type). We can thus pass a value of type Frame () to anything that expects some Window a. For a button this works too, as it is a synonym for Control (CButton ()) which is in turn a synonym for Window (CControl (CButton ())). Note that we can't pass a frame to something that expects a value of type Control a. Of course, a Window a is actually a type synonym for EvtHandler (CWindow a). If you study the documentation in Graphics.UI.WX.Classes closely, you can discover where this chain ends :-).

Objects are not automatically deleted. Normally you can use a delete function like windowDelete to delete an object. However, almost all objects in the wxWidgets library are automatically deleted by the library. The only objects that should be used with care are resources as bitmaps, fonts and brushes.

Instances

Eq (Object a) Source # 

Methods

(==) :: Object a -> Object a -> Bool #

(/=) :: Object a -> Object a -> Bool #

Ord (Object a) Source # 

Methods

compare :: Object a -> Object a -> Ordering #

(<) :: Object a -> Object a -> Bool #

(<=) :: Object a -> Object a -> Bool #

(>) :: Object a -> Object a -> Bool #

(>=) :: Object a -> Object a -> Bool #

max :: Object a -> Object a -> Object a #

min :: Object a -> Object a -> Object a #

Show (Object a) Source # 

Methods

showsPrec :: Int -> Object a -> ShowS #

show :: Object a -> String #

showList :: [Object a] -> ShowS #

Widget (Window a) Source # 

Methods

widget :: Window a -> Layout Source #

objectNull :: Object a Source #

A null object. Use with care.

objectIsNull :: Object a -> Bool Source #

Test for null object.

objectCast :: Object a -> Object b Source #

Cast an object to another type. Use with care.

objectIsManaged :: Object a -> Bool Source #

Is this a managed object?

objectDelete :: WxObject a -> IO () Source #

Delete a wxObject, works for managed and unmanaged objects.

withObjectPtr :: Object a -> (Ptr a -> IO b) -> IO b Source #

Do something with the object pointer.

withObjectRef :: String -> Object a -> (Ptr a -> IO b) -> IO b Source #

Extract the object pointer and raise an exception if NULL. Otherwise continue with the valid pointer.

withObjectResult :: IO (Ptr a) -> IO (Object a) Source #

Return an unmanaged object.

withManagedObjectResult :: IO (Ptr (TWxObject a)) -> IO (WxObject a) Source #

Create a managed object that will be deleted using |wxObject_SafeDelete|.

objectFinalize :: Object a -> IO () Source #

Finalize a managed object manually. (No effect on unmanaged objects.)

objectNoFinalize :: Object a -> IO () Source #

Remove the finalizer on a managed object. (No effect on unmanaged objects.)

objectFromPtr :: Ptr a -> Object a Source #

Create an unmanaged object.

managedObjectFromPtr :: Ptr (TWxObject a) -> IO (WxObject a) Source #

Create a managed object that will be deleted using |wxObject_SafeDelete|.

Identifiers

type Id = Int Source #

An Id is used to identify objects during event handling.

idAny :: Id Source #

When creating a new window you may specify idAny to let wxWidgets assign an unused identifier to it automatically. Furthermore, it can be used in an event connection to handle events for any identifier.

idCreate :: IO Id Source #

Create a new unique identifier.

Bits

(.+.) :: Bits a => a -> a -> a infixl 5 Source #

Bitwise or of two bit masks.

(.-.) :: Bits a => a -> a -> a infixl 5 Source #

Unset certain bits in a bitmask.

bits :: (Num a, Bits a) => [a] -> a Source #

Bitwise or of a list of bit masks.

bitsSet :: Bits a => a -> a -> Bool Source #

(bitsSet mask i) tests if all bits in mask are also set in i.

Control

unitIO :: IO a -> IO () Source #

Ignore the result of an IO action.

bracket Source #

Arguments

:: IO a

computation to run first (acquire resource)

-> (a -> IO b)

computation to run last (release resource)

-> (a -> IO c)

computation to run in-between (use resource)

-> IO c 

Properly release resources, even in the event of an exception.

bracket_ Source #

Arguments

:: IO a

computation to run first (acquire resource)

-> IO b

computation to run last (release resource)

-> IO c

computation to run in-between (use resource)

-> IO c 

Specialized variant of bracket where the return value is not required.

finally Source #

Arguments

:: IO a

computation to run first

-> IO b

computation to run last (release resource)

-> IO a 

Run some computation afterwards, even if an exception occurs.

finalize Source #

Arguments

:: IO b

computation to run last (release resource)

-> IO a

computation to run first

-> IO a 

Run some computation afterwards, even if an exception occurs. Equals finally but with the arguments swapped.

when :: Bool -> IO () -> IO () Source #

Perform an action when a test succeeds.

Variables

type Var a = TVar a Source #

A mutable variable. Use this instead of MVars or IORefs to accommodate for future expansions with possible concurrency.

varCreate :: a -> IO (Var a) Source #

Create a fresh mutable variable.

varGet :: Var a -> IO a Source #

Get the value of a mutable variable.

varSet :: Var a -> a -> IO () Source #

Set the value of a mutable variable.

varUpdate :: Var a -> (a -> a) -> IO a Source #

Update the value of a mutable variable and return the old value.

varSwap :: Var a -> a -> IO a Source #

Swap the value of a mutable variable.

Misc.

type Style = Int Source #

A Style is normally used as a flag mask to specify some window style

type EventId = Int Source #

An EventId is identifies specific events.

data TreeItem Source #

Identifies tree items. Note: Replaces the TreeItemId object and takes automatically care of allocation issues.

treeItemInvalid :: TreeItem Source #

Invalid tree item.

treeItemIsOk :: TreeItem -> Bool Source #

Is a tree item ok? (i.e. not invalid).

Basic types

Booleans

Colors

data Color Source #

An abstract data type to define colors.

Instances

Eq Color Source # 

Methods

(==) :: Color -> Color -> Bool #

(/=) :: Color -> Color -> Bool #

Show Color Source # 

Methods

showsPrec :: Int -> Color -> ShowS #

show :: Color -> String #

showList :: [Color] -> ShowS #

rgb :: Integral a => a -> a -> a -> Color Source #

Create a color from a red/green/blue triple.

colorRGB :: Integral a => a -> a -> a -> Color Source #

Create a color from a red/green/blue triple.

colorRed :: Num a => Color -> a Source #

Returns a red color component

colorGreen :: Num a => Color -> a Source #

Returns a green color component

colorBlue :: Num a => Color -> a Source #

Returns a blue color component

intFromColor :: Color -> Int Source #

Return an Int where the three least significant bytes contain the red, green, and blue component of a color.

colorFromInt :: Int -> Color Source #

Set the color according to an rgb integer. (see rgbIntFromColor).

colorIsOk :: Color -> Bool Source #

Check of a color is valid (Colour::IsOk)

colorOk :: Color -> Bool Source #

Deprecated: Use colorIsOk instead

deprecated: use colorIsOk instead.

System colors

data SystemColor Source #

System Colors.

Constructors

ColorScrollBar

The scrollbar grey area.

ColorBackground

The desktop colour.

ColorActiveCaption

Active window caption.

ColorInactiveCaption

Inactive window caption.

ColorMenu

Menu background.

ColorWindow

Window background.

ColorWindowFrame

Window frame.

ColorMenuText

Menu text.

ColorWindowText

Text in windows.

ColorCaptionText

Text in caption, size box and scrollbar arrow box.

ColorActiveBorder

Active window border.

ColorInactiveBorder

Inactive window border.

ColorAppWorkspace

Background colour MDI -- ^applications.

ColorHighlight

Item(s) selected in a control.

ColorHighlightText

Text of item(s) selected in a control.

ColorBtnFace

Face shading on push buttons.

ColorBtnShadow

Edge shading on push buttons.

ColorGrayText

Greyed (disabled) text.

ColorBtnText

Text on push buttons.

ColorInactiveCaptionText

Colour of text in active captions.

ColorBtnHighlight

Highlight colour for buttons (same as 3DHILIGHT).

Color3DDkShadow

Dark shadow for three-dimensional display elements.

Color3DLight

Light colour for three-dimensional display elements.

ColorInfoText

Text colour for tooltip controls.

ColorInfoBk

Background colour for tooltip controls.

ColorDesktop

Same as BACKGROUND.

Color3DFace

Same as BTNFACE.

Color3DShadow

Same as BTNSHADOW.

Color3DHighlight

Same as BTNHIGHLIGHT.

Color3DHilight

Same as BTNHIGHLIGHT.

ColorBtnHilight

Same as BTNHIGHLIGHT.

colorSystem :: SystemColor -> Color Source #

Convert a system color to a color.

Points

data Num a => Point2 a Source #

A point has an x and y coordinate. Coordinates are normally relative to the upper-left corner of their view frame, where a positive x goes to the right and a positive y to the bottom of the view.

Constructors

Point 

Fields

  • pointX :: !a

    x component of a point.

  • pointY :: !a

    y component of a point.

Instances

(Eq a, Num a) => Eq (Point2 a) Source # 

Methods

(==) :: Point2 a -> Point2 a -> Bool #

(/=) :: Point2 a -> Point2 a -> Bool #

(Num a, Ord a) => Ord (Point2 a) Source # 

Methods

compare :: Point2 a -> Point2 a -> Ordering #

(<) :: Point2 a -> Point2 a -> Bool #

(<=) :: Point2 a -> Point2 a -> Bool #

(>) :: Point2 a -> Point2 a -> Bool #

(>=) :: Point2 a -> Point2 a -> Bool #

max :: Point2 a -> Point2 a -> Point2 a #

min :: Point2 a -> Point2 a -> Point2 a #

(Read a, Num a) => Read (Point2 a) Source # 
(Show a, Num a) => Show (Point2 a) Source # 

Methods

showsPrec :: Int -> Point2 a -> ShowS #

show :: Point2 a -> String #

showList :: [Point2 a] -> ShowS #

Ix (Point2 Int) Source # 

point :: Num a => a -> a -> Point2 a Source #

Construct a point.

pt :: Num a => a -> a -> Point2 a Source #

Shorter function to construct a point.

pointZero :: Num a => Point2 a Source #

Point at the origin.

pointNull :: Num a => Point2 a Source #

A null point is not a legal point (x and y are -1) and can be used for some wxWidgets functions to select a default point.

Sizes

data Num a => Size2D a Source #

A Size has a width and height.

Constructors

Size 

Fields

  • sizeW :: !a

    the width of a size

  • sizeH :: !a

    the height of a size

Instances

(Eq a, Num a) => Eq (Size2D a) Source # 

Methods

(==) :: Size2D a -> Size2D a -> Bool #

(/=) :: Size2D a -> Size2D a -> Bool #

(Show a, Num a) => Show (Size2D a) Source # 

Methods

showsPrec :: Int -> Size2D a -> ShowS #

show :: Size2D a -> String #

showList :: [Size2D a] -> ShowS #

sz :: Num a => a -> a -> Size2D a Source #

Short function to construct a size

sizeNull :: Num a => Size2D a Source #

A null size is not a legal size (width and height are -1) and can be used for some wxWidgets functions to select a default size.

sizeEncloses :: (Num a, Ord a) => Size2D a -> Size2D a -> Bool Source #

Returns True if the first size totally encloses the second argument.

sizeMin :: (Num a, Ord a) => Size2D a -> Size2D a -> Size2D a Source #

The minimum of two sizes.

sizeMax :: (Num a, Ord a) => Size2D a -> Size2D a -> Size2D a Source #

The maximum of two sizes.

Vectors

data Num a => Vector2 a Source #

A vector with an x and y delta.

Constructors

Vector 

Fields

  • vecX :: !a

    delta-x component of a vector

  • vecY :: !a

    delta-y component of a vector

Instances

(Eq a, Num a) => Eq (Vector2 a) Source # 

Methods

(==) :: Vector2 a -> Vector2 a -> Bool #

(/=) :: Vector2 a -> Vector2 a -> Bool #

(Read a, Num a) => Read (Vector2 a) Source # 
(Show a, Num a) => Show (Vector2 a) Source # 

Methods

showsPrec :: Int -> Vector2 a -> ShowS #

show :: Vector2 a -> String #

showList :: [Vector2 a] -> ShowS #

vector :: Num a => a -> a -> Vector2 a Source #

Construct a vector.

vec :: Num a => a -> a -> Vector2 a Source #

Short function to construct a vector.

vecZero :: Num a => Vector2 a Source #

A zero vector

vecNull :: Num a => Vector2 a Source #

A null vector has a delta x and y of -1 and can be used for some wxWidgets functions to select a default vector.

Rectangles

data Num a => Rect2D a Source #

A rectangle is defined by the left x coordinate, the top y coordinate, the width and the height.

Constructors

Rect 

Fields

Instances

(Eq a, Num a) => Eq (Rect2D a) Source # 

Methods

(==) :: Rect2D a -> Rect2D a -> Bool #

(/=) :: Rect2D a -> Rect2D a -> Bool #

(Read a, Num a) => Read (Rect2D a) Source # 
(Show a, Num a) => Show (Rect2D a) Source # 

Methods

showsPrec :: Int -> Rect2D a -> ShowS #

show :: Rect2D a -> String #

showList :: [Rect2D a] -> ShowS #

rect :: Num a => Point2 a -> Size2D a -> Rect2D a Source #

Create a rectangle at a certain (upper-left) point with a certain size.

rectBetween :: (Num a, Ord a) => Point2 a -> Point2 a -> Rect2D a Source #

Construct a (positive) rectangle between two (arbitrary) points.

rectFromSize :: Num a => Size2D a -> Rect2D a Source #

Create a rectangle of a certain size with the upper-left corner at (pt 0 0).

rectZero :: Num a => Rect2D a Source #

An empty rectangle at (0,0).

rectNull :: Num a => Rect2D a Source #

An null rectangle is not a valid rectangle (Rect -1 -1 -1 -1) but can used for some wxWidgets functions to select a default rectangle. (i.e. frameCreate).

rectSize :: Num a => Rect2D a -> Size2D a Source #

Get the size of a rectangle.

rectsDiff :: (Num a, Ord a) => Rect2D a -> Rect2D a -> [Rect2D a] Source #

A list with rectangles that constitute the difference between two rectangles.

rectOverlap :: (Num a, Ord a) => Rect2D a -> Rect2D a -> Rect2D a Source #

The intersection between two rectangles.