Portability | portable (depends on GHC) |
---|---|
Stability | provisional |
Maintainer | gtk2hs-users@lists.sourceforge.net |
Graphics.UI.Gtk.General.Enums
Description
General enumeration types.
- data AccelFlags
- = AccelVisible
- | AccelLocked
- | AccelMask
- data ArrowType
- = ArrowUp
- | ArrowDown
- | ArrowLeft
- | ArrowRight
- | ArrowNone
- data AttachOptions
- data MouseButton
- = LeftButton
- | MiddleButton
- | RightButton
- | OtherButton Int
- data ButtonBoxStyle
- data CalendarDisplayOptions
- data Click
- data CornerType
- data DeleteType
- data DestDefaults
- data DragResult
- data DirectionType
- = DirTabForward
- | DirTabBackward
- | DirUp
- | DirDown
- | DirLeft
- | DirRight
- data Justification
- data MatchType
- = MatchAll
- | MatchAllTail
- | MatchHead
- | MatchTail
- | MatchExact
- | MatchLast
- data MenuDirectionType
- data MetricType
- = Pixels
- | Inches
- | Centimeters
- data MovementStep
- data Orientation
- data Packing
- = PackRepel
- | PackGrow
- | PackNatural
- toPacking :: Bool -> Bool -> Packing
- fromPacking :: Packing -> (Bool, Bool)
- data PackType
- data PathPriorityType
- data PathType
- data PolicyType
- data PositionType
- data ProgressBarOrientation
- data ReliefStyle
- = ReliefNormal
- | ReliefHalf
- | ReliefNone
- data ResizeMode
- data ScrollType
- data ScrollStep
- data SelectionMode
- data ShadowType
- = ShadowNone
- | ShadowIn
- | ShadowOut
- | ShadowEtchedIn
- | ShadowEtchedOut
- data SortType
- data StateType
- data SubmenuDirection
- data SubmenuPlacement
- data SpinButtonUpdatePolicy
- data SpinType
- data TargetFlags
- data TextDirection
- = TextDirNone
- | TextDirLtr
- | TextDirRtl
- data TextSearchFlags
- data TextWindowType
- data ToolbarStyle
- data TreeViewColumnSizing
- data UpdateType
- data Visibility
- data WindowPosition
- data WindowType
- data WrapMode
- = WrapNone
- | WrapChar
- | WrapWord
- | WrapWordChar
- data EntryIconPosition
- data AnchorType
- = AnchorCenter
- | AnchorNorth
- | AnchorNorthWest
- | AnchorNorthEast
- | AnchorSouth
- | AnchorSouthWest
- | AnchorSouthEast
- | AnchorWest
- | AnchorEast
- | AnchorN
- | AnchorNw
- | AnchorNe
- | AnchorS
- | AnchorSw
- | AnchorSe
- | AnchorW
- | AnchorE
- data CapStyle
- = CapNotLast
- | CapButt
- | CapRound
- | CapProjecting
- data CrossingMode
- data Dither
- data DragProtocol
- data DragAction
- = ActionDefault
- | ActionCopy
- | ActionMove
- | ActionLink
- | ActionPrivate
- | ActionAsk
- 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 ExtensionMode
- data Fill
- = Solid
- | Tiled
- | Stippled
- | OpaqueStippled
- data Function
- data InputCondition
- data JoinStyle
- data LineStyle
- data NotifyType
- data ScrollDirection
- = ScrollUp
- | ScrollDown
- | ScrollLeft
- | ScrollRight
- data SubwindowMode
- 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
Documentation
data AccelFlags Source
State of an accelerator
Constructors
AccelVisible | |
AccelLocked | |
AccelMask |
Instances
Bounded AccelFlags | |
Enum AccelFlags | Arrow directions for the arrow widget |
Eq AccelFlags | |
Show AccelFlags | |
Flags AccelFlags |
Constructors
ArrowUp | |
ArrowDown | |
ArrowLeft | |
ArrowRight | |
ArrowNone |
data AttachOptions Source
Child widget attach options for table containers
Instances
Bounded AttachOptions | |
Enum AttachOptions | Mouse buttons. |
Eq AttachOptions | |
Show AttachOptions | |
Flags AttachOptions |
data ButtonBoxStyle Source
Dictate the style that a ButtonBox uses to align it contents
Constructors
ButtonboxDefaultStyle | |
ButtonboxSpread | |
ButtonboxEdge | |
ButtonboxStart | |
ButtonboxEnd | |
ButtonboxCenter |
Instances
data CalendarDisplayOptions Source
Specify which items of a calendar should be displayed.
Type of mouse click
Constructors
SingleClick | |
DoubleClick | |
TripleClick | |
ReleaseClick |
data CornerType Source
Specifies in which corner a child widget should be placed
Constructors
CornerTopLeft | |
CornerBottomLeft | |
CornerTopRight | |
CornerBottomRight |
Instances
data DeleteType Source
Editing option
Constructors
DeleteChars | |
DeleteWordEnds | |
DeleteWords | |
DeleteDisplayLines | |
DeleteDisplayLineEnds | |
DeleteParagraphEnds | |
DeleteParagraphs | |
DeleteWhitespace |
Instances
data DestDefaults Source
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 callGraphics.UI.Gtk.Gdk.Drag.dragStatus
as 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 callGraphics.UI.Gtk.Gdk.Drag.dragGetData
on behalf of the widget. Whether or not the drop is successful, GTK+ will callGraphics.UI.Gtk.Gdk.Drag.dragFinish
. If the action was a move, then if the drag was successful, thenTrue
will be passed for the delete parameter toGraphics.UI.Gtk.Gdk.Drag.dragFinish
-
DestDefaultAll
: 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 Source
Constructors
DragResultSuccess | |
DragResultNoTarget | |
DragResultUserCancelled | |
DragResultTimeoutExpired | |
DragResultGrabBroken | |
DragResultError |
Instances
data DirectionType Source
Editing direction
Constructors
DirTabForward | |
DirTabBackward | |
DirUp | |
DirDown | |
DirLeft | |
DirRight |
Instances
data Justification Source
Justification for label and maybe other widgets (text?)
Constructors
JustifyLeft | |
JustifyRight | |
JustifyCenter | |
JustifyFill |
Instances
Some kind of string search options
Constructors
MatchAll | |
MatchAllTail | |
MatchHead | |
MatchTail | |
MatchExact | |
MatchLast |
data MenuDirectionType Source
From where was a menu item entered?
Constructors
MenuDirParent | |
MenuDirChild | |
MenuDirNext | |
MenuDirPrev |
data MovementStep Source
Movement in text widget
Constructors
Instances
data Orientation Source
Orientation is good
Constructors
OrientationHorizontal | |
OrientationVertical |
Instances
Packing parameters of a widget
- The
Packing
parameter determines how the child behaves in the horizontal or vertical way in anGraphics.UI.Gtk.Layout.HBox
orGraphics.UI.Gtk.Layout.VBox
, respectively.PackNatural
means the child is as big as it reqests. It will stay at the start of the end of aGraphics.UI.Gtk.Layout.Box
if there is more space available. All children packed withPackRepel
will be padded on both sides with additional space.PackGrow
will 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 aGraphics.UI.Gtk.Layout.VBox
with 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 optionPackGrow
is the right choice and it is irrelevant whether the main area is inserted at the start or the end of a box. FinallyPackRepel
is 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)Source
Packing of widgets at start or end in a box
data PathPriorityType Source
Priorities
Instances
Enum PathPriorityType | Scrollbar policy types (for scrolled windows) |
Eq PathPriorityType | |
Show PathPriorityType |
Widget identification path
Constructors
PathWidget | |
PathWidgetClass | |
PathClass |
data ProgressBarOrientation Source
Is the ProgressBar horizontally or vertically directed?
data ReliefStyle Source
I don't have a clue.
Constructors
ReliefNormal | |
ReliefHalf | |
ReliefNone |
Instances
data ResizeMode Source
Resize mode, for containers
-
ResizeParent
Pass resize request to the parent -
ResizeQueue
Queue resizes on this widget -
ResizeImmediate
Perform the resizes now
Constructors
ResizeParent | |
ResizeQueue | |
ResizeImmediate |
Instances
data ScrollType Source
Scrolling type
Constructors
Instances
data ScrollStep Source
Scrolling step
Constructors
ScrollSteps | |
ScrollPages | |
ScrollEnds | |
ScrollHorizontalSteps | |
ScrollHorizontalPages | |
ScrollHorizontalEnds |
Instances
data SelectionMode Source
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 Source
Shadow types
Constructors
ShadowNone | |
ShadowIn | |
ShadowOut | |
ShadowEtchedIn | |
ShadowEtchedOut |
Instances
Constructors
SortAscending | |
SortDescending |
Widget states
Constructors
StateNormal | |
StateActive | |
StatePrelight | |
StateSelected | |
StateInsensitive |
data SpinButtonUpdatePolicy Source
Whether to clamp or ignore illegal values.
Constructors
UpdateAlways | |
UpdateIfValid |
Spin a SpinButton with the following method.
data TargetFlags Source
The TargetFlags
enumeration is used to specify constraints on an entry
in a Graphics.UI.Gtk.Gdk.Selection.TargetList
. These flags are only
used for drag and drop.
- If the
TargetSameApp
flag is set, the target will only be selected for drags within a single application. - If the
TargetSameWidget
flag 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 Source
Specify the way the search function for
Graphics.UI.Gtk.Multiline.TextBuffer
works.
Constructors
TextSearchVisibleOnly | |
TextSearchTextOnly |
data TextWindowType Source
The window type for coordinate translation.
Constructors
TextWindowPrivate | |
TextWindowWidget | |
TextWindowText | |
TextWindowLeft | |
TextWindowRight | |
TextWindowTop | |
TextWindowBottom |
Instances
data ToolbarStyle Source
Where to place the toolbar?
Constructors
ToolbarIcons | |
ToolbarText | |
ToolbarBoth | |
ToolbarBothHoriz |
Instances
data TreeViewColumnSizing Source
Wether columns of a tree or list widget can be resized.
data UpdateType Source
Updating types for range widgets (determines when the
"connectToValueChanged"
signal is emitted by the widget)
Constructors
UpdateContinuous | |
UpdateDiscontinuous | |
UpdateDelayed |
Instances
data Visibility Source
Visibility
Constructors
VisibilityNone | |
VisibilityPartial | |
VisibilityFull |
Instances
data WindowType Source
Interaction of a window with window manager
Constructors
WindowToplevel | |
WindowPopup |
Instances
Determine how lines are wrapped in a Graphics.UI.Gtk.Multiline.TextView
.
Constructors
WrapNone | |
WrapChar | |
WrapWord | |
WrapWordChar |
data EntryIconPosition Source
Specifies the side of the entry at which an icon is placed.
Constructors
EntryIconPrimary | |
EntryIconSecondary |
data AnchorType Source
Constructors
AnchorCenter | |
AnchorNorth | |
AnchorNorthWest | |
AnchorNorthEast | |
AnchorSouth | |
AnchorSouthWest | |
AnchorSouthEast | |
AnchorWest | |
AnchorEast | |
AnchorN | |
AnchorNw | |
AnchorNe | |
AnchorS | |
AnchorSw | |
AnchorSe | |
AnchorW | |
AnchorE |
Instances
Specify the how the ends of a line is drawn.
Constructors
CapNotLast | |
CapButt | |
CapRound | |
CapProjecting |
data CrossingMode Source
How focus is crossing the widget.
Constructors
CrossingNormal | |
CrossingGrab | |
CrossingUngrab | |
CrossingGtkGrab | |
CrossingGtkUngrab | |
CrossingStateChanged |
Instances
Specify how to dither colors onto the screen.
Constructors
RgbDitherNone | |
RgbDitherNormal | |
RgbDitherMax |
data DragProtocol Source
Used in Graphics.UI.Gtk.Gdk.Drag.DragContext
to indicate the protocol according to which DND is done.
data DragAction Source
Used in Graphics.UI.Gtk.Genearl.Drag.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
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
Alt2
and theMeta
key (if available). - Since Gtk 2.10, there are also
Super
,Hyper
andMeta
modifiers which are simply generated fromAlt
..Compose
modifier keys, depending on the mapping used by the windowing system. Due to one key being mapped to e.g.Alt2
andMeta
, you shouldn't pattern match directly against a certain key but check whether a key is in the list using theelem
function, say.
data ExtensionMode Source
specify which input extension a widget desires
How objects are filled.
Constructors
Solid | |
Tiled | |
Stippled | |
OpaqueStippled |
Determine how bitmap operations are carried out.
data InputCondition Source
Specify on what file condition a callback should be done.
Constructors
InputRead | |
InputWrite | |
InputException |
Instances
Bounded InputCondition | |
Enum InputCondition | Determines how adjacent line ends are drawn. |
Eq InputCondition | |
Flags InputCondition |
Determines if a line is solid or dashed.
Constructors
LineSolid | |
LineOnOffDash | |
LineDoubleDash |
data NotifyType Source
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
Enum NotifyType | Determine if child widget may be overdrawn. |
Eq NotifyType | |
Show NotifyType |
data ScrollDirection Source
in which direction was scrolled?
Constructors
ScrollUp | |
ScrollDown | |
ScrollLeft | |
ScrollRight |
Instances
data SubwindowMode Source
Constructors
ClipByChildren | |
IncludeInferiors |
Instances
Enum SubwindowMode | visibility of a window |
Eq SubwindowMode | |
Show SubwindowMode |
data VisibilityState Source
Instances
data WindowState Source
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 Source
Determines a window edge or corner.
Constructors
WindowEdgeNorthWest | |
WindowEdgeNorth | |
WindowEdgeNorthEast | |
WindowEdgeWest | |
WindowEdgeEast | |
WindowEdgeSouthWest | |
WindowEdgeSouth | |
WindowEdgeSouthEast |
Instances
data WindowTypeHint Source
Constructors
Instances
Defines the reference point of a window and the meaning of coordinates
passed to Graphics.UI.Gtk.Windows.Window.windowMove
. See
Graphics.UI.Gtk.Windows.Window.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 Source
Instances
Enum GrabStatus | Specifies why a selection ownership was changed.
|
Eq GrabStatus | |
Show GrabStatus |
data OwnerChange Source
Constructors
OwnerChangeNewOwner | |
OwnerChangeDestroy | |
OwnerChangeClose |
Instances