Copyright | (c) Daan Leijen 2003 |
---|---|
License | wxWindows |
Maintainer | wxhaskell-devel@lists.sourceforge.net |
Stability | provisional |
Portability | portable |
Safe Haskell | None |
Language | Haskell2010 |
Basic types and operations.
- (#) :: obj -> (obj -> a) -> a
- data Object a
- objectNull :: Object a
- objectIsNull :: Object a -> Bool
- objectCast :: Object a -> Object b
- objectIsManaged :: Object a -> Bool
- objectDelete :: WxObject a -> IO ()
- withObjectPtr :: Object a -> (Ptr a -> IO b) -> IO b
- withObjectRef :: String -> Object a -> (Ptr a -> IO b) -> IO b
- withObjectResult :: IO (Ptr a) -> IO (Object a)
- withManagedObjectResult :: IO (Ptr (TWxObject a)) -> IO (WxObject a)
- objectFinalize :: Object a -> IO ()
- objectNoFinalize :: Object a -> IO ()
- objectFromPtr :: Ptr a -> Object a
- managedObjectFromPtr :: Ptr (TWxObject a) -> IO (WxObject a)
- type Id = Int
- idAny :: Id
- idCreate :: IO Id
- (.+.) :: Bits a => a -> a -> a
- (.-.) :: Bits a => a -> a -> a
- bits :: (Num a, Bits a) => [a] -> a
- bitsSet :: Bits a => a -> a -> Bool
- unitIO :: IO a -> IO ()
- bracket :: IO a -> (a -> IO b) -> (a -> IO c) -> IO c
- bracket_ :: IO a -> IO b -> IO c -> IO c
- finally :: IO a -> IO b -> IO a
- finalize :: IO b -> IO a -> IO a
- when :: Bool -> IO () -> IO ()
- type Var a = TVar a
- varCreate :: a -> IO (Var a)
- varGet :: Var a -> IO a
- varSet :: Var a -> a -> IO ()
- varUpdate :: Var a -> (a -> a) -> IO a
- varSwap :: Var a -> a -> IO a
- type Style = Int
- type EventId = Int
- data TreeItem
- treeItemInvalid :: TreeItem
- treeItemIsOk :: TreeItem -> Bool
- data Color
- rgb :: Integral a => a -> a -> a -> Color
- colorRGB :: Integral a => a -> a -> a -> Color
- colorRed :: Num a => Color -> a
- colorGreen :: Num a => Color -> a
- colorBlue :: Num a => Color -> a
- intFromColor :: Color -> Int
- colorFromInt :: Int -> Color
- colorIsOk :: Color -> Bool
- colorOk :: Color -> Bool
- data SystemColor
- = ColorScrollBar
- | ColorBackground
- | ColorActiveCaption
- | ColorInactiveCaption
- | ColorMenu
- | ColorWindow
- | ColorWindowFrame
- | ColorMenuText
- | ColorWindowText
- | ColorCaptionText
- | ColorActiveBorder
- | ColorInactiveBorder
- | ColorAppWorkspace
- | ColorHighlight
- | ColorHighlightText
- | ColorBtnFace
- | ColorBtnShadow
- | ColorGrayText
- | ColorBtnText
- | ColorInactiveCaptionText
- | ColorBtnHighlight
- | Color3DDkShadow
- | Color3DLight
- | ColorInfoText
- | ColorInfoBk
- | ColorDesktop
- | Color3DFace
- | Color3DShadow
- | Color3DHighlight
- | Color3DHilight
- | ColorBtnHilight
- colorSystem :: SystemColor -> Color
- data Num a => Point2 a = Point {}
- point :: Num a => a -> a -> Point2 a
- pt :: Num a => a -> a -> Point2 a
- pointZero :: Num a => Point2 a
- pointNull :: Num a => Point2 a
- data Num a => Size2D a = Size {}
- sz :: Num a => a -> a -> Size2D a
- sizeNull :: Num a => Size2D a
- sizeEncloses :: (Num a, Ord a) => Size2D a -> Size2D a -> Bool
- sizeMin :: (Num a, Ord a) => Size2D a -> Size2D a -> Size2D a
- sizeMax :: (Num a, Ord a) => Size2D a -> Size2D a -> Size2D a
- data Num a => Vector2 a = Vector {}
- vector :: Num a => a -> a -> Vector2 a
- vec :: Num a => a -> a -> Vector2 a
- vecZero :: Num a => Vector2 a
- vecNull :: Num a => Vector2 a
- data Num a => Rect2D a = Rect {
- rectLeft :: !a
- rectTop :: !a
- rectWidth :: !a
- rectHeight :: !a
- rect :: Num a => Point2 a -> Size2D a -> Rect2D a
- rectBetween :: (Num a, Ord a) => Point2 a -> Point2 a -> Rect2D a
- rectFromSize :: Num a => Size2D a -> Rect2D a
- rectZero :: Num a => Rect2D a
- rectNull :: Num a => Rect2D a
- rectSize :: Num a => Rect2D a -> Size2D a
- rectsDiff :: (Num a, Ord a) => Rect2D a -> Rect2D a -> [Rect2D a]
- rectOverlap :: (Num a, Ord a) => Rect2D a -> Rect2D a -> Rect2D a
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"
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.
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.
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.
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
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.
Bits
bitsSet :: Bits a => a -> a -> Bool Source #
(bitsSet mask i
) tests if all bits in mask
are also set in i
.
Control
:: 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.
:: 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.
Run some computation afterwards, even if an exception occurs.
Run some computation afterwards, even if an exception occurs. Equals finally
but
with the arguments swapped.
Variables
A mutable variable. Use this instead of MVar
s or IORef
s to accommodate for
future expansions with possible concurrency.
varUpdate :: Var a -> (a -> a) -> IO a Source #
Update the value of a mutable variable and return the old value.
Misc.
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
colorGreen :: Num a => Color -> a Source #
Returns a green 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
).
colorOk :: Color -> Bool Source #
Deprecated: Use colorIsOk instead
deprecated: use colorIsOk
instead.
System colors
data SystemColor Source #
System Colors.
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.
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
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.
Vectors
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.
Rect | |
|
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).
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
).