Portability | portable |
---|---|
Stability | provisional |
Maintainer | wxhaskell-devel@lists.sourceforge.net |
Safe Haskell | None |
Graphics.UI.WX.Classes
Contents
Description
This modules defines attributes common to many widgets and organizes them into Haskell classes. Look at the instance definitions to see what kind of widgets support the attributes.
Sometimes it is
hard to find what attributes a certain widget supports since the instance
definitions might be on some class higher in the hierarchy. For example,
many instances are defined for Window
a
-- this means that all
those attributes are applicable to any kind of Window
, i.e. frames,
buttons, panels etc. However, these attributes will not be explicitly
listed at the type definitions of those classes.
- data Border
- class Textual w where
- class Literate w where
- font :: Attr w FontStyle
- fontSize :: Attr w Int
- fontWeight :: Attr w FontWeight
- fontFamily :: Attr w FontFamily
- fontShape :: Attr w FontShape
- fontFace :: Attr w String
- fontUnderline :: Attr w Bool
- textColor :: Attr w Color
- textBgcolor :: Attr w Color
- class Dimensions w where
- class Colored w where
- class Visible w where
- class Bordered w where
- class Child w where
- class Parent w where
- class Closeable w where
- class Selection w where
- class Selections w where
- selections :: Attr w [Int]
- class Items w a | w -> a where
- class Able w where
- class Help w where
- class Tipped w where
- class Identity w where
- class Styled w where
- class Framed w where
- resizeable :: Attr w Bool
- minimizeable :: Attr w Bool
- maximizeable :: Attr w Bool
- closeable :: Attr w Bool
- class Checkable w where
- class Dockable w where
- class Pictured w where
- class Valued w where
- class Sized w where
- class HasDefault w where
- unsafeDefaultItem :: Attr w (Window ())
- defaultButton :: Attr w (Button ())
Data types
data Border
Window borders
Constructors
BorderSimple | Displays a thin border around the window. |
BorderDouble | Displays a double border. Windows only. |
BorderSunken | Displays a sunken border. |
BorderRaised | Displays a raised border. |
BorderStatic | Displays a border suitable for a static control. Windows only |
BorderNone | No border |
Text
class Textual w where
Widgets with a label or text field.
Methods
The text of a widget. It is interpreted differently for for different widgets, for example, the title of a frame or the content of a static text control.
appendText :: w -> String -> IO ()
class Literate w where
Widgets with a font.
Methods
The font of the widget.
The font size.
fontWeight :: Attr w FontWeight
The font weight.
fontFamily :: Attr w FontFamily
The font family.
The font style.
The font face: determines a platform dependent font.
fontUnderline :: Attr w Bool
Is the font underlined?
Text color.
textBgcolor :: Attr w Color
Text background color
Rendering
class Dimensions w where
Widgets that have a size.
Methods
The outer size of a widget (in pixels).
The (relative) position of a widget.
The occupied area.
The preferred size of a widget.
clientSize :: Attr w Size
The area available for client use (i.e. without the border etc).
virtualSize :: Attr w Size
The virtual size of a widget (ie. the total scrolling area)
Instances
Dimensions (Window a) |
class Colored w where
class Visible w where
Visible widgets.
class Bordered w where
Widgets with a border.
Hierarchy
class Child w where
Widgets that are part of a hierarchical order.
class Parent w where
Parent widgets.
class Closeable w where
Widgets that can be closed.
Containers
class Selection w where
Widgets with a single selection (radio group or listbox)
Methods
The current selection as a zero-based index. Certain widgets return -1 when no item is selected.
class Items w a | w -> a where
Widgets containing certain items (like strings in a listbox)
Methods
Number of items.
All the items as a list. This attribute might not be writable for some widgets (like radioboxes)
An item by zero-based index.
itemDelete :: w -> Int -> IO ()
Delete an item. Only valid for writeable items.
itemsDelete :: w -> IO ()
Delete all items. Only valid for writeable items.
itemAppend :: w -> a -> IO ()
Append an item. Only valid for writeable items.
Misc.
class Able w where
Widgets that can be enabled or disabled.
class Identity w where
The identity determines the wxWindows ID of a widget.
class Styled w where
The style is a bitmask that determines various properties of a widget.
class Framed w where
Widgets that have a system frame around them.
Methods
resizeable :: Attr w Bool
Make the widget user resizeable? This attribute must be set at creation time.
minimizeable :: Attr w Bool
Can the widget be minimized? This attribute must be set at creation time.
maximizeable :: Attr w Bool
Can the widget be maximized? This attribute must be set at creation time
and is normally used together with resizeable
.
Can the widget be closed by the user? This attribute must be set at creation time.
Instances
Framed (TopLevelWindow a) |
class Pictured w where
Widgets with a picture.
Instances
Pictured (BitmapButton a) | |
Pictured (TopLevelWindow a) |
class Valued w where
Items with a value.
class Sized w where
Sized objects (like bitmaps)
class HasDefault w where
Objects which activate a Window
by default keypress
Methods
unsafeDefaultItem :: Attr w (Window ())
Define a default item as any type deriving from Window
. Great care
is required when using this option as you will have to cast the item
to/from Window() using objectCast
.
For the common use case where the window in question is a Button
,
please use defaultButton
as it is typesafe.
defaultButton :: Attr w (Button ())
Define the default button for a TopLevelWindow
. This is recommended
for most use cases as the most common default control is a Button
.
Instances