| Maintainer | gtk2hs-users@lists.sourceforge.net |
|---|---|
| Stability | provisional |
| Portability | portable (depends on GHC) |
| Safe Haskell | Safe |
| Language | Haskell98 |
Graphics.UI.Gtk.General.Enums
Description
General enumeration types.
- data AccelFlags
- data ArrowType
- data AttachOptions
- data MouseButton
- data ButtonBoxStyle
- data CalendarDisplayOptions
- data Click
- data CornerType
- data DeleteType
- data DestDefaults
- data DragResult
- data DirectionType
- data Justification
- data MatchType
- data MenuDirectionType
- data MetricType
- = Pixels
- | Inches
- | Centimeters
- data MovementStep
- data Orientation
- data Packing
- toPacking :: Bool -> Bool -> Packing
- fromPacking :: Packing -> (Bool, Bool)
- data PackType
- data PathPriorityType
- data PathType
- data PolicyType
- data PositionType
- data ProgressBarOrientation
- data ReliefStyle
- data ResizeMode
- data ScrollType
- data ScrollStep
- data SelectionMode
- data ShadowType
- data SortType
- data StateType
- data SubmenuDirection
- data SubmenuPlacement
- data SpinButtonUpdatePolicy
- data SpinType
- data TargetFlags
- data TextDirection
- data TextSearchFlags
- data TextWindowType
- data ToolbarStyle
- data TreeViewColumnSizing
- data UpdateType
- data Visibility
- data WindowPosition
- data WindowType
- data WrapMode
- data EntryIconPosition
- data AnchorType
- data CrossingMode
- data DragProtocol
- data DragAction
- data EventMask
- = ExposureMask
- | PointerMotionMask
- | PointerMotionHintMask
- | ButtonMotionMask
- | Button1MotionMask
- | Button2MotionMask
- | Button3MotionMask
- | ButtonPressMask
- | ButtonReleaseMask
- | KeyPressMask
- | KeyReleaseMask
- | EnterNotifyMask
- | LeaveNotifyMask
- | FocusChangeMask
- | StructureMask
- | PropertyChangeMask
- | VisibilityNotifyMask
- | ProximityInMask
- | ProximityOutMask
- | SubstructureMask
- | ScrollMask
- | AllEventsMask
- data Modifier
- data NotifyType
- data ScrollDirection
- data VisibilityState
- data WindowState
- data WindowEdge
- data WindowTypeHint
- = WindowTypeHintNormal
- | WindowTypeHintDialog
- | WindowTypeHintMenu
- | WindowTypeHintToolbar
- | WindowTypeHintSplashscreen
- | WindowTypeHintUtility
- | WindowTypeHintDock
- | WindowTypeHintDesktop
- | WindowTypeHintDropdownMenu
- | WindowTypeHintPopupMenu
- | WindowTypeHintTooltip
- | WindowTypeHintNotification
- | WindowTypeHintCombo
- | WindowTypeHintDnd
- data Gravity
- data GrabStatus
- data OwnerChange
- data ExtensionMode
- data CapStyle
- data Dither
- data Fill
- = Solid
- | Tiled
- | Stippled
- | OpaqueStippled
- data Function
- data InputCondition
- data JoinStyle
- data LineStyle
- data SubwindowMode
Documentation
Arrow directions for the arrow widget
Constructors
| ArrowUp | |
| ArrowDown | |
| ArrowLeft | |
| ArrowRight | |
| ArrowNone |
data MouseButton #
Mouse buttons.
Constructors
| LeftButton | |
| MiddleButton | |
| RightButton | |
| OtherButton Int |
Instances
data ButtonBoxStyle #
Dictate the style that a ButtonBox uses to align it contents
Constructors
| ButtonboxDefaultStyle | |
| ButtonboxSpread | |
| ButtonboxEdge | |
| ButtonboxStart | |
| ButtonboxEnd | |
| ButtonboxCenter |
Instances
data CalendarDisplayOptions #
Specify which items of a calendar should be displayed.
Type of mouse click
Constructors
| SingleClick | |
| DoubleClick | |
| TripleClick | |
| ReleaseClick |
data CornerType #
Specifies in which corner a child widget should be placed
Constructors
| CornerTopLeft | |
| CornerBottomLeft | |
| CornerTopRight | |
| CornerBottomRight |
Instances
data DeleteType #
Editing option
Constructors
| DeleteChars | |
| DeleteWordEnds | |
| DeleteWords | |
| DeleteDisplayLines | |
| DeleteDisplayLineEnds | |
| DeleteParagraphEnds | |
| DeleteParagraphs | |
| DeleteWhitespace |
Instances
data DestDefaults #
The DestDefaults enumeration specifies the various types of action that
will be taken on behalf of the user for a drag destination site.
DestDefaultMotion: If set for a widget, GTK+, during a drag over this widget will check if the drag matches this widget's list of possible targets and actions. GTK+ will then calldragStatusas appropriate.DestDefaultHighlight: If set for a widget, GTK+ will draw a highlight on this widget as long as a drag is over this widget and the widget drag format and action are acceptable.DestDefaultDrop: If set for a widget, when a drop occurs, GTK+ will will check if the drag matches this widget's list of possible targets and actions. If so, GTK+ will calldragGetDataon behalf of the widget. Whether or not the drop is successful, GTK+ will calldragFinish. If the action was a move, then if the drag was successful, thenTruewill be passed for the delete parameter todragFinishDestDefaultAll: If set, specifies that all default actions should be taken.
Instances
| Bounded DestDefaults # | |
| Enum DestDefaults # | Gives an indication why a drag operation failed. The value can by
obtained by connecting to the
|
| Eq DestDefaults # | |
| Show DestDefaults # | |
| Flags DestDefaults # | |
data DragResult #
Constructors
| DragResultSuccess | |
| DragResultNoTarget | |
| DragResultUserCancelled | |
| DragResultTimeoutExpired | |
| DragResultGrabBroken | |
| DragResultError |
Instances
data DirectionType #
Editing direction
Constructors
| DirTabForward | |
| DirTabBackward | |
| DirUp | |
| DirDown | |
| DirLeft | |
| DirRight |
Instances
data Justification #
Justification for label and maybe other widgets (text?)
Constructors
| JustifyLeft | |
| JustifyRight | |
| JustifyCenter | |
| JustifyFill |
Instances
Some kind of string search options
Removed in Gtk3.
Constructors
| MatchAll | |
| MatchAllTail | |
| MatchHead | |
| MatchTail | |
| MatchExact | |
| MatchLast |
data MenuDirectionType #
From where was a menu item entered?
Constructors
| MenuDirParent | |
| MenuDirChild | |
| MenuDirNext | |
| MenuDirPrev |
Instances
data MovementStep #
Movement in text widget
Constructors
Instances
data Orientation #
Orientation is good
Constructors
| OrientationHorizontal | |
| OrientationVertical |
Instances
Packing parameters of a widget
- The
Packingparameter determines how the child behaves in the horizontal or vertical way in anHBoxorVBox, respectively.PackNaturalmeans the child is as big as it requests. It will stay at the start or end of aBoxif there is more space available. All children packed withPackRepelwill be padded on both sides with additional space.PackGrowwill increase the size of a widget so that it covers the available space. A menu bar, for instance, should always stay at the top of a window and should only occupy as little space as possible. Hence it should be packed at the start of aVBoxwith the packing optionPackNatural. The working area of a window (e.g. the text area in an editor) should expand when the window is resized. Here the packing optionPackGrowis the right choice and it is irrelevant whether the main area is inserted at the start or the end of a box. FinallyPackRepelis most useful in a window where no widget can make use of excess space. Examples include a dialog box without list boxes or text fields.
Constructors
| PackRepel | |
| PackGrow | |
| PackNatural |
fromPacking :: Packing -> (Bool, Bool) #
Packing of widgets at start or end in a box
data PathPriorityType #
Priorities
Instances
| Enum PathPriorityType # | Scrollbar policy types (for scrolled windows) |
| Eq PathPriorityType # | |
| Show PathPriorityType # | |
Widget identification path
Constructors
| PathWidget | |
| PathWidgetClass | |
| PathClass |
data ProgressBarOrientation #
Is the ProgressBar horizontally or vertically directed?
Removed in Gtk3.
data ResizeMode #
Resize mode, for containers
ResizeParentPass resize request to the parentResizeQueueQueue resizes on this widgetResizeImmediatePerform the resizes now
Constructors
| ResizeParent | |
| ResizeQueue | |
| ResizeImmediate |
Instances
data ScrollType #
Scrolling type
Constructors
Instances
data ScrollStep #
Scrolling step
Constructors
| ScrollSteps | |
| ScrollPages | |
| ScrollEnds | |
| ScrollHorizontalSteps | |
| ScrollHorizontalPages | |
| ScrollHorizontalEnds |
Instances
data SelectionMode #
Mode in which selections can be performed
- There is a deprecated entry SelectionExtended which should have the same value as SelectionMultiple. C2HS chokes on that construct.
Constructors
| SelectionNone | |
| SelectionSingle | |
| SelectionBrowse | |
| SelectionMultiple |
Instances
data ShadowType #
Shadow types
Constructors
| ShadowNone | |
| ShadowIn | |
| ShadowOut | |
| ShadowEtchedIn | |
| ShadowEtchedOut |
Instances
Constructors
| SortAscending | |
| SortDescending |
Widget states
Constructors
| StateNormal | |
| StateActive | |
| StatePrelight | |
| StateSelected | |
| StateInsensitive |
data SubmenuDirection #
Submenu direction policies
Removed in Gtk3.
Constructors
| DirectionLeft | |
| DirectionRight |
data SpinButtonUpdatePolicy #
Whether to clamp or ignore illegal values.
Constructors
| UpdateAlways | |
| UpdateIfValid |
Spin a SpinButton with the following method.
data TargetFlags #
The TargetFlags enumeration is used to specify constraints on an entry
in a TargetList. These flags are only
used for drag and drop.
- If the
TargetSameAppflag is set, the target will only be selected for drags within a single application. - If the
TargetSameWidgetflag is set, the target will only be selected for drags within a single widget.
Constructors
| TargetSameApp | |
| TargetSameWidget | |
| TargetOtherApp | |
| TargetOtherWidget |
Instances
| Bounded TargetFlags # | |
| Enum TargetFlags # | Is the text written from left to right or the exotic way? |
| Eq TargetFlags # | |
| Show TargetFlags # | |
| Flags TargetFlags # | |
data TextSearchFlags #
Specify the way the search function for
TextBuffer works.
Constructors
| TextSearchVisibleOnly | |
| TextSearchTextOnly |
data TextWindowType #
The window type for coordinate translation.
Constructors
| TextWindowPrivate | |
| TextWindowWidget | |
| TextWindowText | |
| TextWindowLeft | |
| TextWindowRight | |
| TextWindowTop | |
| TextWindowBottom |
Instances
data ToolbarStyle #
Where to place the toolbar?
Constructors
| ToolbarIcons | |
| ToolbarText | |
| ToolbarBoth | |
| ToolbarBothHoriz |
Instances
data TreeViewColumnSizing #
Wether columns of a tree or list widget can be resized.
data UpdateType #
Updating types for range widgets (determines when the
"connectToValueChanged" signal is emitted by the widget)
Removed in Gtk3.
Constructors
| UpdateContinuous | |
| UpdateDiscontinuous | |
| UpdateDelayed |
Instances
data Visibility #
Visibility
Removed in Gtk3.
Constructors
| VisibilityNone | |
| VisibilityPartial | |
| VisibilityFull |
Instances
data WindowType #
Interaction of a window with window manager
Constructors
| WindowToplevel | |
| WindowPopup |
Instances
Determine how lines are wrapped in a TextView.
Constructors
| WrapNone | |
| WrapChar | |
| WrapWord | |
| WrapWordChar |
data EntryIconPosition #
Specifies the side of the entry at which an icon is placed.
Constructors
| EntryIconPrimary | |
| EntryIconSecondary |
Instances
data AnchorType #
Removed in Gtk3.
Constructors
| AnchorCenter | |
| AnchorNorth | |
| AnchorNorthWest | |
| AnchorNorthEast | |
| AnchorSouth | |
| AnchorSouthWest | |
| AnchorSouthEast | |
| AnchorWest | |
| AnchorEast | |
| AnchorN | |
| AnchorNw | |
| AnchorNe | |
| AnchorS | |
| AnchorSw | |
| AnchorSe | |
| AnchorW | |
| AnchorE |
Instances
data CrossingMode #
How focus is crossing the widget.
Constructors
| CrossingNormal | |
| CrossingGrab | |
| CrossingUngrab | |
| CrossingGtkGrab | |
| CrossingGtkUngrab | |
| CrossingStateChanged |
Instances
data DragProtocol #
Used in DragContext to indicate the protocol according to which DND is done.
Constructors
| DragProtoMotif | |
| DragProtoXdnd | |
| DragProtoRootwin | |
| DragProtoNone | |
| DragProtoWin32Dropfiles | |
| DragProtoOle2 | |
| DragProtoLocal |
Instances
data DragAction #
Used in DragContext to indicate what the
destination should do with the dropped data.
ActionDefault: Initialisation value, should not be used.ActionCopy: Copy the data.ActionMove: Move the data, i.e. first copy it, then delete it from the source.ActionLink: Add a link to the data. Note that this is only useful if source and destination agree on what it means.ActionPrivate: Special action which tells the source that the destination will do something that the source doesn't understand.ActionAsk: Ask the user what to do with the data.
Constructors
| ActionDefault | |
| ActionCopy | |
| ActionMove | |
| ActionLink | |
| ActionPrivate | |
| ActionAsk |
Instances
| Bounded DragAction # | |
| Enum DragAction # | Specify how to dither colors onto the screen. Removed in Gtk3. |
| Eq DragAction # | |
| Show DragAction # | |
| Flags DragAction # | |
Specify which events a widget will emit signals on.
Constructors
Keyboard modifiers that are depressed when the user presses a key or a mouse button.
- This data type is used to build lists of modifers that were active during an event.
- The Apple key on Macintoshs is mapped to
Alt2and theMetakey (if available). - Since Gtk 2.10, there are also
Super,HyperandMetamodifiers which are simply generated fromAlt..Composemodifier keys, depending on the mapping used by the windowing system. Due to one key being mapped to e.g.Alt2andMeta, you shouldn't pattern match directly against a certain key but check whether a key is in the list using theelemfunction, say.
data NotifyType #
Information on from what level of the widget hierarchy the mouse cursor came.
NotifyAncestor- The window is entered from an ancestor or left towards an ancestor.
NotifyVirtual- The pointer moves between an ancestor and an inferior of the window.
NotifyInferior- The window is entered from an inferior or left towards an inferior.
NotifyNonlinear- The window is entered from or left towards a window which is neither an ancestor nor an inferior.
NotifyNonlinearVirtual- The pointer moves between two windows which are not ancestors of each other and the window is part of the ancestor chain between one of these windows and their least common ancestor.
NotifyUnknown- The level change does not fit into any of the other categories or could not be determined.
Constructors
| NotifyAncestor | |
| NotifyVirtual | |
| NotifyInferior | |
| NotifyNonlinear | |
| NotifyNonlinearVirtual | |
| NotifyUnknown |
Instances
data ScrollDirection #
in which direction was scrolled?
Constructors
| ScrollUp | |
| ScrollDown | |
| ScrollLeft | |
| ScrollRight |
Instances
data VisibilityState #
Instances
data WindowState #
The state a DrawWindow is in.
Constructors
| WindowStateWithdrawn | |
| WindowStateIconified | |
| WindowStateMaximized | |
| WindowStateSticky | |
| WindowStateFullscreen | |
| WindowStateAbove | |
| WindowStateBelow |
Instances
| Bounded WindowState # | |
| Enum WindowState # | These are hints for the window manager that indicate what type of function the window has. The window manager can use this when determining decoration and behaviour of the window. The hint must be set before mapping the window. See the extended window manager hints specification for more details about window types. |
| Eq WindowState # | |
| Show WindowState # | |
| Flags WindowState # | |
data WindowEdge #
Determines a window edge or corner.
Constructors
| WindowEdgeNorthWest | |
| WindowEdgeNorth | |
| WindowEdgeNorthEast | |
| WindowEdgeWest | |
| WindowEdgeEast | |
| WindowEdgeSouthWest | |
| WindowEdgeSouth | |
| WindowEdgeSouthEast |
Instances
data WindowTypeHint #
Constructors
Instances
Defines the reference point of a window and the meaning of coordinates
passed to windowMove. See
windowMove and the "implementation notes"
section of the extended window manager hints specification for more details.
Constructors
| GravityNorthWest | |
| GravityNorth | |
| GravityNorthEast | |
| GravityWest | |
| GravityCenter | |
| GravityEast | |
| GravitySouthWest | |
| GravitySouth | |
| GravitySouthEast | |
| GravityStatic |
Instances
| Enum Gravity # | Returned by
|
| Eq Gravity # | |
| Show Gravity # | |
data GrabStatus #
Instances
| Enum GrabStatus # | Specifies why a selection ownership was changed.
|
| Eq GrabStatus # | |
| Show GrabStatus # | |
Specify the how the ends of a line is drawn.
Removed in Gtk3.
Constructors
| CapNotLast | |
| CapButt | |
| CapRound | |
| CapProjecting |
Constructors
| RgbDitherNone | |
| RgbDitherNormal | |
| RgbDitherMax |
How objects are filled.
Removed in Gtk3.
Constructors
| Solid | |
| Tiled | |
| Stippled | |
| OpaqueStippled |
Determine how bitmap operations are carried out.
Removed in Gtk3.
data InputCondition #
Specify on what file condition a callback should be done.
Removed in Gtk3.
Constructors
| InputRead | |
| InputWrite | |
| InputException |
Instances
| Bounded InputCondition # | |
| Enum InputCondition # | Determines how adjacent line ends are drawn. Removed in Gtk3. |
| Eq InputCondition # | |
| Flags InputCondition # | |
Determines if a line is solid or dashed.
Removed in Gtk3.
Constructors
| LineSolid | |
| LineOnOffDash | |
| LineDoubleDash |
data SubwindowMode #
Determine if child widget may be overdrawn.
Removed in Gtk3.
Constructors
| ClipByChildren | |
| IncludeInferiors |
Instances
| Enum SubwindowMode # | visibility of a window |
| Eq SubwindowMode # | |
| Show SubwindowMode # | |