Contents Index

Graphics.UI.WX.Classes

Contents Data types Text Rendering Hierarchy Containers Misc.

Description

Synopsis

data Border = BorderSimple | BorderDouble | BorderSunken | BorderRaised | BorderStatic | BorderNone class Textual w where text :: Attr w String appendText :: w -> String -> IO () 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 outerSize :: Attr w Size position :: Attr w Point area :: Attr w Rect bestSize :: ReadAttr w Size clientSize :: Attr w Size virtualSize :: Attr w Size class Colored w where bgcolor :: Attr w Color color :: Attr w Color class Visible w where visible :: Attr w Bool refresh :: w -> IO () fullRepaintOnResize :: Attr w Bool class Bordered w where border :: Attr w Border class Child w where parent :: ReadAttr w (Window ()) class Parent w where children :: ReadAttr w [Window ()] clipChildren :: Attr w Bool class Closeable w where close :: w -> IO () class Selection w where selection :: Attr w Int class Selections w where selections :: Attr w [Int] class Items w a | w -> a where itemCount :: ReadAttr w Int items :: Attr w [a] item :: Int -> Attr w a itemDelete :: w -> Int -> IO () itemsDelete :: w -> IO () itemAppend :: w -> a -> IO () class Able w where enabled :: Attr w Bool class Help w where help :: Attr w String class Tipped w where tooltip :: Attr w String class Identity w where identity :: Attr w Int class Styled w where style :: Attr w Int class Framed w where resizeable :: Attr w Bool minimizeable :: Attr w Bool maximizeable :: Attr w Bool closeable :: Attr w Bool class Checkable w where checkable :: Attr w Bool checked :: Attr w Bool class Dockable w where dockable :: Attr w Bool class Pictured w where picture :: Attr w FilePath class Valued w where value :: Attr (w a) a class Sized w where size :: Attr w Size

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 Instances BitMask Border Eq Border Read Border Show Border Typeable Border

Text

class Textual w where

Widgets with a label or text field. Methods text :: Attr w String 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 () Instances Textual StatusField Textual (Menu a) Textual (MenuItem a) Textual (Window a)

class Literate w where

Widgets with a font. Methods font :: Attr w FontStyle The font of the widget. fontSize :: Attr w Int The font size. fontWeight :: Attr w FontWeight The font weight. fontFamily :: Attr w FontFamily The font family. fontShape :: Attr w FontShape The font style. fontFace :: Attr w String The font face: determines a platform dependent font. fontUnderline :: Attr w Bool Is the font underlined? textColor :: Attr w Color Text color. textBgcolor :: Attr w Color Text background color Instances Literate (DC a) Literate (Window a)

Rendering

class Dimensions w where

Widgets that have a size. Methods outerSize :: Attr w Size The outer size of a widget (in pixels). position :: Attr w Point The (relative) position of a widget. area :: Attr w Rect The occupied area. bestSize :: ReadAttr w Size 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

Methods bgcolor :: Attr w Color The background color. color :: Attr w Color The (foreground) color Instances Colored (DC a) Colored (Window a)

class Visible w where

Visible widgets. Methods visible :: Attr w Bool Is the widget visible? refresh :: w -> IO () Refresh the widget explicitly. fullRepaintOnResize :: Attr w Bool Should the widget be fully repainted on resize? This attribute only has effect when set at creation. If False, you will have to repaint the new window area manually at a resize, but flickering caused by background redraws can be prevented in this way. (False by default) Instances Visible (Window a)

class Bordered w where

Widgets with a border. Methods border :: Attr w Border Specify the border of a widget. Instances Bordered (Window a)

Hierarchy

class Child w where

Widgets that are part of a hierarchical order. Methods parent :: ReadAttr w (Window ()) The parent widget. Instances Child (Window a)

class Parent w where

Parent widgets. Methods children :: ReadAttr w [Window ()] Get the child widgets of a window. clipChildren :: Attr w Bool Reduce flicker by not redrawing the background under child controls. This attribute has to be set at creation time. (True by default) Instances Parent (Window a)

class Closeable w where

Widgets that can be closed. Methods close :: w -> IO () Close the widget. Instances Closeable (Frame a)

Containers

class Selection w where

Widgets with a single selection (radio group or listbox) Methods selection :: Attr w Int The current selection as a zero-based index. Certain widgets return -1 when no item is selected. Instances Selection (Choice ()) Selection (ComboBox a) Selection (Gauge a) Selection (RadioBox a) Selection (SingleListBox a) Selection (Slider a) Selection (SpinCtrl a)

class Selections w where

Widget with zero or more selections (multi select list boxes) Methods selections :: Attr w [Int] The currently selected items in zero-based indices. Instances Selections (MultiListBox a)

class Items w a | w -> a where

Widgets containing certain items (like strings in a listbox) Methods itemCount :: ReadAttr w Int Number of items. items :: Attr w [a] All the items as a list. This attribute might not be writable for some widgets (like radioboxes) item :: Int -> Attr w a 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. Instances Items (Choice a) String Items (ListBox a) String Items (RadioBox a) String Items (ListCtrl a) [String]

Misc.

class Able w where

Widgets that can be enabled or disabled. Methods enabled :: Attr w Bool Enable, or disable, the widget. Instances Able Timer Able ToolBarItem Able (MenuItem a) Able (Window a)

class Help w where

Widgets with help text. Methods help :: Attr w String Short help text, normally displayed in the status bar or popup balloon. Instances Help ToolBarItem Help (MenuItem a)

class Tipped w where

Widgets that have a tooltip Methods tooltip :: Attr w String The tooltip information Instances Tipped ToolBarItem Tipped (Window a)

class Identity w where

The identity determines the wxWindows ID of a widget. Methods identity :: Attr w Int The identity determines the wxWindows ID of a widget. Instances Identity ToolBarItem Identity (MenuItem a) Identity (Window a)

class Styled w where

The style is a bitmask that determines various properties of a widget. Methods style :: Attr w Int The windows style. Instances Styled (Window a)

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. closeable :: Attr w Bool Can the widget be closed by the user? This attribute must be set at creation time. Instances Framed (Dialog a) Framed (Frame a)

class Checkable w where

Checkable widgets Methods checkable :: Attr w Bool Is the widget checkable? checked :: Attr w Bool Is the widget checked? Instances Checkable ToolBarItem Checkable (CheckBox a) Checkable (MenuItem a)

class Dockable w where

Dockable widgets. Methods dockable :: Attr w Bool Is the widget dockable?

class Pictured w where

Widgets with a picture. Methods picture :: Attr w FilePath The image of a widget. Instances Pictured (BitmapButton a) Pictured (Frame a)

class Valued w where

Items with a value. Methods value :: Attr (w a) a The value of an object. Instances Valued IORef

class Sized w where

Sized objects (like bitmaps) Methods size :: Attr w Size The size of an object. (is outerSize for Dimensions widgets). Instances Sized (Bitmap a) Sized (Image a) Sized (Window a)

Produced by Haddock version 0.8