Portability | portable |
---|---|
Stability | provisional |
Maintainer | wxhaskell-devel@lists.sourceforge.net |
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
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
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 ()Source
Widgets with a font.
Methods
font :: Attr w FontStyleSource
The font of the widget.
The font size.
fontWeight :: Attr w FontWeightSource
The font weight.
fontFamily :: Attr w FontFamilySource
The font family.
fontShape :: Attr w FontShapeSource
The font style.
fontFace :: Attr w StringSource
The font face: determines a platform dependent font.
fontUnderline :: Attr w BoolSource
Is the font underlined?
textColor :: Attr w ColorSource
Text color.
textBgcolor :: Attr w ColorSource
Text background color
Rendering
class Dimensions w whereSource
Widgets that have a size.
Methods
outerSize :: Attr w SizeSource
The outer size of a widget (in pixels).
position :: Attr w PointSource
The (relative) position of a widget.
The occupied area.
bestSize :: ReadAttr w SizeSource
The preferred size of a widget.
clientSize :: Attr w SizeSource
The area available for client use (i.e. without the border etc).
virtualSize :: Attr w SizeSource
The virtual size of a widget (ie. the total scrolling area)
Instances
Dimensions (Window a) |
Methods
The background color.
The (foreground) color
Visible widgets.
Methods
Is the widget visible?
Refresh the widget explicitly.
Widgets with a border.
Hierarchy
Widgets that are part of a hierarchical order.
Parent widgets.
Widgets that can be closed.
Containers
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 Selections w whereSource
Widget with zero or more selections (multi select list boxes)
Instances
class Items w a | w -> a whereSource
Widgets containing certain items (like strings in a listbox)
Methods
itemCount :: ReadAttr w IntSource
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 ()Source
Delete an item. Only valid for writeable items.
itemsDelete :: w -> IO ()Source
Delete all items. Only valid for writeable items.
itemAppend :: w -> a -> IO ()Source
Append an item. Only valid for writeable items.
Misc.
Widgets that can be enabled or disabled.
Widgets with help text.
Methods
Short help text, normally displayed in the status bar or popup balloon.
Instances
Help ToolBarItem | |
Help (MenuItem a) |
Widgets that have a tooltip
Instances
The identity determines the wxWindows ID of a widget.
The style is a bitmask that determines various properties of a widget.
Widgets that have a system frame around them.
Methods
resizeable :: Attr w BoolSource
Make the widget user resizeable? This attribute must be set at creation time.
minimizeable :: Attr w BoolSource
Can the widget be minimized? This attribute must be set at creation time.
maximizeable :: Attr w BoolSource
Can the widget be maximized? This attribute must be set at creation time
and is normally used together with resizeable
.
closeable :: Attr w BoolSource
Can the widget be closed by the user? This attribute must be set at creation time.
Instances
Framed (TopLevelWindow a) |
Checkable widgets
Dockable widgets.
Widgets with a picture.
Instances
Pictured (BitmapButton a) | |
Pictured (TopLevelWindow a) |
Items with a value.
Sized objects (like bitmaps)
class HasDefault w whereSource
Objects which activate a Window
by default keypress
Methods
unsafeDefaultItem :: Attr w (Window ())Source
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 ())Source
Define the default button for a TopLevelWindow
. This is recommended
for most use cases as the most common default control is a Button
.
Instances