|
|
|
|
|
| Description |
|
|
| Synopsis |
|
|
|
|
| Classes
|
|
|
| Alignment.
| | Constructors | | AlignLeft | | | AlignRight | | | AlignCentre | |
| Instances | |
|
|
|
| Widgets that can have aligned content.
Note: this property is not
used to set the alignment of a widget itself -- See Graphics.UI.WXCore.Layout
for more information about layout.
| | | Methods | | | Set the alignment of the content. Due to wxWidgets constrictions,
this property has to be set at creation time.
|
|
|
|
|
| Set the alignment of the content. Due to wxWidgets constrictions,
this property has to be set at creation time.
|
|
|
| Wrap mode.
| | Constructors | | WrapNone | No wrapping (and show a horizontal scrollbar).
| | WrapLine | Wrap lines that are too long at any position.
| | WrapWord | Wrap lines that are too long at word boundaries.
|
| Instances | |
|
|
|
| Widgets that have wrappable content.
| | | Methods | | | Set the wrap mode of a widget.
|
|
|
|
|
| Set the wrap mode of a widget.
|
|
|
| Widgets that have sorted contents.
| | | Methods | | | Is the content of the widget sorted?
|
|
|
|
|
| Is the content of the widget sorted?
|
|
| Containers
|
|
| panel :: Window a -> [Prop (Panel ())] -> IO (Panel ()) | Source |
|
Create a Panel, a window that is normally used as a container for
controls. It has a standard background and maintains standard keyboard
navigation (ie. Tab moves through the controls).
- Attributes: defaultButton, focusOn
- Instances: Form -- Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled,
Textual, Literate
|
|
| panelEx :: Window a -> Style -> [Prop (Panel ())] -> IO (Panel ()) | Source |
|
Create a Panel with a specific style.
- Attributes: defaultButton, focusOn
- Instances: Form -- Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled,
Textual, Literate, Reactive, Paint
|
|
|
|
| notebook :: Window a -> [Prop (Notebook ())] -> IO (Notebook ()) | Source |
|
Create a Notebook. Layout is managed with the tabs combinator.
- Instances: Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled,
Textual, Literate, Reactive, Paint
|
|
|
| Set the initial focus on this control.
|
|
| Controls
|
|
| Button
|
|
| button :: Window a -> [Prop (Button ())] -> IO (Button ()) | Source |
|
Create a standard push button.
- Instances: Commanding -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| buttonEx :: Window a -> Style -> [Prop (Button ())] -> IO (Button ()) | Source |
|
Create a standard push button with the given flags.
- Instances: Commanding -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| smallButton :: Window a -> [Prop (Button ())] -> IO (Button ()) | Source |
|
Create a minimially sized push button.
- Instances: Commanding -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| bitmapButton :: Window a -> [Prop (BitmapButton ())] -> IO (BitmapButton ()) | Source |
|
Create a bitmap button. Use the image attribute to set the
bitmap.
- Instances: Commanding -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| Text entry
|
|
| entry :: Window a -> [Prop (TextCtrl ())] -> IO (TextCtrl ()) | Source |
|
Create a single-line text entry control. Note: alignment has to
be set at creation time (or the entry has default alignment (=left) ).
- Instances: Wrap, Aligned, Commanding -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| textEntry :: Window a -> [Prop (TextCtrl ())] -> IO (TextCtrl ()) | Source |
|
Create a single-line text entry control. Note: alignment has to
be set at creation time (or the entry has default alignment (=left) ).
- Instances: Wrap, Aligned, Commanding -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| textCtrl :: Window a -> [Prop (TextCtrl ())] -> IO (TextCtrl ()) | Source |
|
Create a multi-line text control. Note: the wrap and alignment
have to be set at creation time or the default to WrapNone and AlignLeft respectively.
- Instances: Wrap, Aligned, Commanding -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| textCtrlRich :: Window a -> [Prop (TextCtrl ())] -> IO (TextCtrl ()) | Source |
|
Create a multi-line text rich-text control with a certain wrap mode
Enables font and color settings on windows, while being equal to textCtrl
on other platforms. Note: the wrap and alignment
have to be set at creation time or the default to WrapNone and AlignLeft respectively.
- Instances: Wrap, Aligned, Commanding -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| textCtrlEx :: Window a -> Style -> [Prop (TextCtrl ())] -> IO (TextCtrl ()) | Source |
|
Create a generic text control given a certain style.
- Instances: Wrap, Aligned, Commanding -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
|
| Process enter key events, used in a comboBox or textCtrl and
catched using a on command handler.
(otherwise pressing Enter is either processed
internally by the control or used for navigation between dialog controls).
|
|
|
| Process tab key events, used in a comboBox or textCtrl.
(otherwise pressing Tab is either processed
internally by the control or used for navigation between dialog controls).
|
|
| CheckBox
|
|
| checkBox :: Window a -> [Prop (CheckBox ())] -> IO (CheckBox ()) | Source |
|
Create a new checkbox.
- Instances: Commanding,Checkable -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| Choice
|
|
| choice :: Window a -> [Prop (Choice ())] -> IO (Choice ()) | Source |
|
Create a choice item to select a one of a list of strings.
- Instances: Sorted, Selecting,Selection,Items -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| choiceEx :: Window a -> Style -> [Prop (Choice ())] -> IO (Choice ()) | Source |
|
Create a choice item, given a set of style flags, to select a one of a list of strings
- Instances: Selecting,Selection,Items -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| ComboBox
|
|
| comboBox :: Window a -> [Prop (ComboBox ())] -> IO (ComboBox ()) | Source |
|
Create a new combo box.
- Instances: Selecting, Commanding,Selection,Items -- Textual, Literate, Dimensions,
Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
A command event is triggered when the enter key is pressed and when
processEnter has been set to True.
|
|
| comboBoxEx :: Window a -> Style -> [Prop (ComboBox ())] -> IO (ComboBox ()) | Source |
|
Create a new combo box with a given set of flags.
- Instances: Selecting, Commanding,Selection,Items -- Textual, Literate, Dimensions,
Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
A command event is triggered when the enter key is pressed and when
processEnter has been set to True.
|
|
| ListBox
|
|
| type SingleListBox a = ListBox (CSingleListBox a) | Source |
|
| Pointer to single selection list boxes, deriving from ListBox.
|
|
| type MultiListBox a = ListBox (CMultiListBox a) | Source |
|
| Pointer to multiple selection list boxes, deriving from ListBox.
|
|
|
Create a single selection list box.
- Instances: Sorted,Selecting,Selection,Items -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
|
|
| RadioBox
|
|
| radioBox :: Window a -> Orientation -> [String] -> [Prop (RadioBox ())] -> IO (RadioBox ()) | Source |
|
Create a new radio button group with an initial orientation and a list of
labels. Use selection to get the currently selected item.
- Instances: Selecting,Selection,Items -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| Spin Control
|
|
|
Create a spin control: a text field with up/down buttons. The value (selection)
is always between a specified minimum and maximum.
- Instances: Selection, Selecting -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| Slider
|
|
|
Create a horizontal slider with a specified minimum and maximum. Set
the Bool argument to True to show labels (minimumn, maximum, and
current value). The selection attribute gives the current value.
- Instances: Commanding,Selection -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
|
Create a vertical slider with a specified minimum and maximum. Set
the Bool argument to True to show labels (minimumn, maximum, and
current value). The selection attribute gives the current value.
- Instances: Commanding,Selection -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
|
Create a slider with a specified minimum and maximum. The
selection attribute gives the current value.
- Instances: Commanding,Selection -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| Gauge
|
|
|
Create a horizontal gauge with a specified integer range (max value).
The selection attribute determines the position of the gauge.
- Instances: Selection -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
|
Create a vertical gauge with a specified integer range (max value).
The selection attribute determines the position of the gauge.
- Instances: Selection -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| gaugeEx :: Window a -> Int -> Style -> [Prop (Gauge ())] -> IO (Gauge ()) | Source |
|
Create a gauge control.
The selection attribute determines the position of the gauge.
- Instances: Selection -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| Tree control
|
|
| treeCtrl :: Window a -> [Prop (TreeCtrl ())] -> IO (TreeCtrl ()) | Source |
|
Create a single-selection tree control with buttons (i.e. + and - signs).
- Attributes: treeEvent
- Instances: Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| treeCtrlEx :: Window a -> Style -> [Prop (TreeCtrl ())] -> IO (TreeCtrl ()) | Source |
|
Create a tree control.
- Attributes: treeEvent
- Instances: Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
|
| Tree control events.
|
|
| List control
|
|
| listCtrl :: Window a -> [Prop (ListCtrl ())] -> IO (ListCtrl ()) | Source |
|
Create a report-style list control.
- Attributes: listEvent, columns
- Instances: Items -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| listCtrlEx :: Window a -> Style -> [Prop (ListCtrl ())] -> IO (ListCtrl ()) | Source |
|
Create a list control.
- Attributes: listEvent, columns
- Instances: Items -- Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
|
| List control events.
|
|
|
| The columns attribute controls the columns in a report-view list control.
|
|
| Static text
|
|
| staticText :: Window a -> [Prop (StaticText ())] -> IO (StaticText ()) | Source |
|
| Create static text label, see also label.
|
|
| SplitterWindow
|
|
| splitterWindow :: Window a -> [Prop (SplitterWindow ())] -> IO (SplitterWindow ()) | Source |
|
Create a splitter window.
- Instances: Textual, Literate, Dimensions, Colored, Visible, Child,
Able, Tipped, Identity, Styled, Reactive, Paint.
|
|
| ImageList
|
|
| imageList :: Size -> IO (ImageList ()) | Source |
|
| Create an empty image list that will contain images of the desired size.
|
|
|
| Create an image list containing the images in the supplied file name list
that will be scaled towards the desired size.
|
|
| MediaCtrl
|
|
|
| Optional back-end for your MediaCtrl.
If you want to know more about back-end, you must see wxWidgets' Document.
http://www.wxwidgets.org/manuals/stable/wx_wxmediactrl.html#choosingbackendwxmediactrl
| | Constructors | | DirectShow | Use ActiveMovie/DirectShow. Default back-end on Windows.
| | MediaControlInterface | Use Media Command Interface. Windows Only.
| | WindowsMediaPlayer10 | Use Windows Media Player 10. Windows Only. Require to use wxWidgets 2.8.x.
| | QuickTime | Use QuickTime. Mac Only.
| | GStreamer | Use GStreamer. Unix Only. Require GStreamer and GStreamer Support.
| | DefaultBackend | Use default back-end on your platform.
|
| Instances | |
|
|
| mediaCtrl :: Window a -> [Prop (MediaCtrl ())] -> IO (MediaCtrl ()) | Source |
|
|
|
Create MediaCtrl with choosing back-end. This is useful to select back-end on
Windows. But if you don't want to cause any effect to other platforms, you must
use wxToolkit or #ifdef macro to choose correct function for platforms.
For example,
import Graphics.UI.WXCore.Defines
...
m <- case wxToolkit of
WxMSW -> mediaCtrlWithBackend f MediaControlInterface []
_ -> mediaCtrl f []
or
#ifdef mingw32_HOST_OS || mingw32_TARGET_OS
m <- mediaCtrlWithBackend f MediaControlInterface []
#else
m <- mediaCtrl f []
#endif
|
|
|
|
| StyledTextCtrl
|
|
|
|
| styledTextCtrl :: Window a -> [Prop (StyledTextCtrl ())] -> IO (StyledTextCtrl ()) | Source |
|
|
| styledTextCtrlEx :: Window a -> Style -> [Prop (StyledTextCtrl ())] -> IO (StyledTextCtrl ()) | Source |
|
|
| Produced by Haddock version 2.1.0 |