gi-atk-2.0.28: Atk bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | Safe-Inferred
Language | Haskell2010

GI.Atk.Enums

Contents

- Enumerations
  - CoordType
  - KeyEventType
  - Layer
  - Live
  - RelationType
  - Role
  - ScrollType
  - StateType
  - TextAttribute
  - TextBoundary
  - TextClipType
  - TextGranularity
  - ValueType

Description

Synopsis

- data CoordType
  - = CoordTypeScreen
  - | CoordTypeWindow
  - | CoordTypeParent
  - | AnotherCoordType Int
- data KeyEventType
  - = KeyEventTypePress
  - | KeyEventTypeRelease
  - | KeyEventTypeLastDefined
  - | AnotherKeyEventType Int
- data Layer
  - = LayerInvalid
  - | LayerBackground
  - | LayerCanvas
  - | LayerWidget
  - | LayerMdi
  - | LayerPopup
  - | LayerOverlay
  - | LayerWindow
  - | AnotherLayer Int
- data Live
  - = LiveNone
  - | LivePolite
  - | LiveAssertive
  - | AnotherLive Int
- data RelationType
  - = RelationTypeNull
  - | RelationTypeControlledBy
  - | RelationTypeControllerFor
  - | RelationTypeLabelFor
  - | RelationTypeLabelledBy
  - | RelationTypeMemberOf
  - | RelationTypeNodeChildOf
  - | RelationTypeFlowsTo
  - | RelationTypeFlowsFrom
  - | RelationTypeSubwindowOf
  - | RelationTypeEmbeds
  - | RelationTypeEmbeddedBy
  - | RelationTypePopupFor
  - | RelationTypeParentWindowOf
  - | RelationTypeDescribedBy
  - | RelationTypeDescriptionFor
  - | RelationTypeNodeParentOf
  - | RelationTypeDetails
  - | RelationTypeDetailsFor
  - | RelationTypeErrorMessage
  - | RelationTypeErrorFor
  - | RelationTypeLastDefined
  - | AnotherRelationType Int
- data Role
  - = RoleInvalid
  - | RoleAcceleratorLabel
  - | RoleAlert
  - | RoleAnimation
  - | RoleArrow
  - | RoleCalendar
  - | RoleCanvas
  - | RoleCheckBox
  - | RoleCheckMenuItem
  - | RoleColorChooser
  - | RoleColumnHeader
  - | RoleComboBox
  - | RoleDateEditor
  - | RoleDesktopIcon
  - | RoleDesktopFrame
  - | RoleDial
  - | RoleDialog
  - | RoleDirectoryPane
  - | RoleDrawingArea
  - | RoleFileChooser
  - | RoleFiller
  - | RoleFontChooser
  - | RoleFrame
  - | RoleGlassPane
  - | RoleHtmlContainer
  - | RoleIcon
  - | RoleImage
  - | RoleInternalFrame
  - | RoleLabel
  - | RoleLayeredPane
  - | RoleList
  - | RoleListItem
  - | RoleMenu
  - | RoleMenuBar
  - | RoleMenuItem
  - | RoleOptionPane
  - | RolePageTab
  - | RolePageTabList
  - | RolePanel
  - | RolePasswordText
  - | RolePopupMenu
  - | RoleProgressBar
  - | RoleButton
  - | RoleRadioButton
  - | RoleRadioMenuItem
  - | RoleRootPane
  - | RoleRowHeader
  - | RoleScrollBar
  - | RoleScrollPane
  - | RoleSeparator
  - | RoleSlider
  - | RoleSplitPane
  - | RoleSpinButton
  - | RoleStatusbar
  - | RoleTable
  - | RoleTableCell
  - | RoleTableColumnHeader
  - | RoleTableRowHeader
  - | RoleTearOffMenuItem
  - | RoleTerminal
  - | RoleText
  - | RoleToggleButton
  - | RoleToolBar
  - | RoleToolTip
  - | RoleTree
  - | RoleTreeTable
  - | RoleUnknown
  - | RoleViewport
  - | RoleWindow
  - | RoleHeader
  - | RoleFooter
  - | RoleParagraph
  - | RoleRuler
  - | RoleApplication
  - | RoleAutocomplete
  - | RoleEditBar
  - | RoleEmbedded
  - | RoleEntry
  - | RoleChart
  - | RoleCaption
  - | RoleDocumentFrame
  - | RoleHeading
  - | RolePage
  - | RoleSection
  - | RoleRedundantObject
  - | RoleForm
  - | RoleLink
  - | RoleInputMethodWindow
  - | RoleTableRow
  - | RoleTreeItem
  - | RoleDocumentSpreadsheet
  - | RoleDocumentPresentation
  - | RoleDocumentText
  - | RoleDocumentWeb
  - | RoleDocumentEmail
  - | RoleComment
  - | RoleListBox
  - | RoleGrouping
  - | RoleImageMap
  - | RoleNotification
  - | RoleInfoBar
  - | RoleLevelBar
  - | RoleTitleBar
  - | RoleBlockQuote
  - | RoleAudio
  - | RoleVideo
  - | RoleDefinition
  - | RoleArticle
  - | RoleLandmark
  - | RoleLog
  - | RoleMarquee
  - | RoleMath
  - | RoleRating
  - | RoleTimer
  - | RoleDescriptionList
  - | RoleDescriptionTerm
  - | RoleDescriptionValue
  - | RoleStatic
  - | RoleMathFraction
  - | RoleMathRoot
  - | RoleSubscript
  - | RoleSuperscript
  - | RoleFootnote
  - | RoleContentDeletion
  - | RoleContentInsertion
  - | RoleMark
  - | RoleSuggestion
  - | RolePushButtonMenu
  - | RoleLastDefined
  - | RolePushButton
  - | AnotherRole Int
- data ScrollType
  - = ScrollTypeTopLeft
  - | ScrollTypeBottomRight
  - | ScrollTypeTopEdge
  - | ScrollTypeBottomEdge
  - | ScrollTypeLeftEdge
  - | ScrollTypeRightEdge
  - | ScrollTypeAnywhere
  - | AnotherScrollType Int
- data StateType
  - = StateTypeInvalid
  - | StateTypeActive
  - | StateTypeArmed
  - | StateTypeBusy
  - | StateTypeChecked
  - | StateTypeDefunct
  - | StateTypeEditable
  - | StateTypeEnabled
  - | StateTypeExpandable
  - | StateTypeExpanded
  - | StateTypeFocusable
  - | StateTypeFocused
  - | StateTypeHorizontal
  - | StateTypeIconified
  - | StateTypeModal
  - | StateTypeMultiLine
  - | StateTypeMultiselectable
  - | StateTypeOpaque
  - | StateTypePressed
  - | StateTypeResizable
  - | StateTypeSelectable
  - | StateTypeSelected
  - | StateTypeSensitive
  - | StateTypeShowing
  - | StateTypeSingleLine
  - | StateTypeStale
  - | StateTypeTransient
  - | StateTypeVertical
  - | StateTypeVisible
  - | StateTypeManagesDescendants
  - | StateTypeIndeterminate
  - | StateTypeTruncated
  - | StateTypeRequired
  - | StateTypeInvalidEntry
  - | StateTypeSupportsAutocompletion
  - | StateTypeSelectableText
  - | StateTypeDefault
  - | StateTypeAnimated
  - | StateTypeVisited
  - | StateTypeCheckable
  - | StateTypeHasPopup
  - | StateTypeHasTooltip
  - | StateTypeReadOnly
  - | StateTypeCollapsed
  - | StateTypeLastDefined
  - | AnotherStateType Int
- data TextAttribute
  - = TextAttributeInvalid
  - | TextAttributeLeftMargin
  - | TextAttributeRightMargin
  - | TextAttributeIndent
  - | TextAttributeInvisible
  - | TextAttributeEditable
  - | TextAttributePixelsAboveLines
  - | TextAttributePixelsBelowLines
  - | TextAttributePixelsInsideWrap
  - | TextAttributeBgFullHeight
  - | TextAttributeRise
  - | TextAttributeUnderline
  - | TextAttributeStrikethrough
  - | TextAttributeSize
  - | TextAttributeScale
  - | TextAttributeWeight
  - | TextAttributeLanguage
  - | TextAttributeFamilyName
  - | TextAttributeBgColor
  - | TextAttributeFgColor
  - | TextAttributeBgStipple
  - | TextAttributeFgStipple
  - | TextAttributeWrapMode
  - | TextAttributeDirection
  - | TextAttributeJustification
  - | TextAttributeStretch
  - | TextAttributeVariant
  - | TextAttributeStyle
  - | TextAttributeTextPosition
  - | TextAttributeLastDefined
  - | AnotherTextAttribute Int
- data TextBoundary
  - = TextBoundaryChar
  - | TextBoundaryWordStart
  - | TextBoundaryWordEnd
  - | TextBoundarySentenceStart
  - | TextBoundarySentenceEnd
  - | TextBoundaryLineStart
  - | TextBoundaryLineEnd
  - | AnotherTextBoundary Int
- data TextClipType
  - = TextClipTypeNone
  - | TextClipTypeMin
  - | TextClipTypeMax
  - | TextClipTypeBoth
  - | AnotherTextClipType Int
- data TextGranularity
  - = TextGranularityChar
  - | TextGranularityWord
  - | TextGranularitySentence
  - | TextGranularityLine
  - | TextGranularityParagraph
  - | AnotherTextGranularity Int
- data ValueType
  - = ValueTypeVeryWeak
  - | ValueTypeWeak
  - | ValueTypeAcceptable
  - | ValueTypeStrong
  - | ValueTypeVeryStrong
  - | ValueTypeVeryLow
  - | ValueTypeLow
  - | ValueTypeMedium
  - | ValueTypeHigh
  - | ValueTypeVeryHigh
  - | ValueTypeVeryBad
  - | ValueTypeBad
  - | ValueTypeGood
  - | ValueTypeVeryGood
  - | ValueTypeBest
  - | ValueTypeLastDefined
  - | AnotherValueType Int

# Enumerations

## CoordType

data CoordType Source #

Specifies how xy coordinates are to be interpreted. Used by functions such as `componentGetPosition` and `textGetCharacterExtents`

Constructors

CoordTypeScreen | specifies xy coordinates relative to the screen
CoordTypeWindow | specifies xy coordinates relative to the widget's top-level window
CoordTypeParent | specifies xy coordinates relative to the widget's immediate parent. Since: 2.30
AnotherCoordType Int | Catch-all for unknown values

#### Instances

Instances details

Enum CoordType Source # |

Instance details

Defined in GI.Atk.Enums

Methods

succ :: CoordType -> CoordType Source #

pred :: CoordType -> CoordType Source #

toEnum :: Int -> CoordType Source #

fromEnum :: CoordType -> Int Source #

enumFrom :: CoordType -> [CoordType] Source #

enumFromThen :: CoordType -> CoordType -> [CoordType] Source #

enumFromTo :: CoordType -> CoordType -> [CoordType] Source #

enumFromThenTo :: CoordType -> CoordType -> CoordType -> [CoordType] Source #

Show CoordType Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> CoordType -> ShowS Source # show :: CoordType -> String Source # showList :: [CoordType] -> ShowS Source #
Eq CoordType Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: CoordType -> CoordType -> Bool Source # (/=) :: CoordType -> CoordType -> Bool Source #
Ord CoordType Source # |
Instance details Defined in GI.Atk.Enums Methods compare :: CoordType -> CoordType -> Ordering Source # (<) :: CoordType -> CoordType -> Bool Source # (<=) :: CoordType -> CoordType -> Bool Source # (>) :: CoordType -> CoordType -> Bool Source # (>=) :: CoordType -> CoordType -> Bool Source # max :: CoordType -> CoordType -> CoordType Source # min :: CoordType -> CoordType -> CoordType Source #
BoxedEnum CoordType Source # |
Instance details Defined in GI.Atk.Enums
TypedObject CoordType Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes CoordType Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes CoordType Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes CoordType = '[] :: [Type]

## KeyEventType

data KeyEventType Source #

Specifies the type of a keyboard evemt.

Constructors

KeyEventTypePress | specifies a key press event
KeyEventTypeRelease | specifies a key release event
KeyEventTypeLastDefined | Not a valid value; specifies end of enumeration
AnotherKeyEventType Int | Catch-all for unknown values

#### Instances

Instances details

Enum KeyEventType Source # |

Instance details

Defined in GI.Atk.Enums

Methods

succ :: KeyEventType -> KeyEventType Source #

pred :: KeyEventType -> KeyEventType Source #

toEnum :: Int -> KeyEventType Source #

fromEnum :: KeyEventType -> Int Source #

enumFrom :: KeyEventType -> [KeyEventType] Source #

enumFromThen :: KeyEventType -> KeyEventType -> [KeyEventType] Source #

enumFromTo :: KeyEventType -> KeyEventType -> [KeyEventType] Source #

enumFromThenTo :: KeyEventType -> KeyEventType -> KeyEventType -> [KeyEventType] Source #

Show KeyEventType Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> KeyEventType -> ShowS Source # show :: KeyEventType -> String Source # showList :: [KeyEventType] -> ShowS Source #
Eq KeyEventType Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: KeyEventType -> KeyEventType -> Bool Source # (/=) :: KeyEventType -> KeyEventType -> Bool Source #
Ord KeyEventType Source # |

Instance details

Defined in GI.Atk.Enums

Methods

compare :: KeyEventType -> KeyEventType -> Ordering Source #

(<) :: KeyEventType -> KeyEventType -> Bool Source #

(<=) :: KeyEventType -> KeyEventType -> Bool Source #

(>) :: KeyEventType -> KeyEventType -> Bool Source #

(>=) :: KeyEventType -> KeyEventType -> Bool Source #

max :: KeyEventType -> KeyEventType -> KeyEventType Source #

min :: KeyEventType -> KeyEventType -> KeyEventType Source #

BoxedEnum KeyEventType Source # |
Instance details Defined in GI.Atk.Enums
TypedObject KeyEventType Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes KeyEventType Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes KeyEventType Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes KeyEventType = '[] :: [Type]

## Layer

data Layer Source #

Describes the layer of a component

These enumerated "layer values" are used when determining which UI rendering layer a component is drawn into, which can help in making determinations of when components occlude one another.

Constructors

LayerInvalid | The object does not have a layer
LayerBackground | This layer is reserved for the desktop background
LayerCanvas | This layer is used for Canvas components
LayerWidget | This layer is normally used for components
LayerMdi | This layer is used for layered components
LayerPopup | This layer is used for popup components, such as menus
LayerOverlay | This layer is reserved for future use.
LayerWindow | This layer is used for toplevel windows.
AnotherLayer Int | Catch-all for unknown values

#### Instances

Instances details

Enum Layer Source # |
Instance details Defined in GI.Atk.Enums Methods succ :: Layer -> Layer Source # pred :: Layer -> Layer Source # toEnum :: Int -> Layer Source # fromEnum :: Layer -> Int Source # enumFrom :: Layer -> [Layer] Source # enumFromThen :: Layer -> Layer -> [Layer] Source # enumFromTo :: Layer -> Layer -> [Layer] Source # enumFromThenTo :: Layer -> Layer -> Layer -> [Layer] Source #
Show Layer Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> Layer -> ShowS Source # show :: Layer -> String Source # showList :: [Layer] -> ShowS Source #
Eq Layer Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: Layer -> Layer -> Bool Source # (/=) :: Layer -> Layer -> Bool Source #
Ord Layer Source # |
Instance details Defined in GI.Atk.Enums Methods compare :: Layer -> Layer -> Ordering Source # (<) :: Layer -> Layer -> Bool Source # (<=) :: Layer -> Layer -> Bool Source # (>) :: Layer -> Layer -> Bool Source # (>=) :: Layer -> Layer -> Bool Source # max :: Layer -> Layer -> Layer Source # min :: Layer -> Layer -> Layer Source #
BoxedEnum Layer Source # |
Instance details Defined in GI.Atk.Enums
TypedObject Layer Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes Layer Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes Layer Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes Layer = '[] :: [Type]

## Live

data Live Source #

Enumeration used to indicate a type of live region and how assertive it should be in terms of speaking notifications. Currently, this is only used for "notification" events, but it may be used for additional purposes in the future.

Since: 2.50

Constructors

LiveNone | No live region.
LivePolite | This live region should be considered polite.
LiveAssertive | This live region should be considered assertive.
AnotherLive Int | Catch-all for unknown values

#### Instances

Instances details

Enum Live Source # |
Instance details Defined in GI.Atk.Enums Methods succ :: Live -> Live Source # pred :: Live -> Live Source # toEnum :: Int -> Live Source # fromEnum :: Live -> Int Source # enumFrom :: Live -> [Live] Source # enumFromThen :: Live -> Live -> [Live] Source # enumFromTo :: Live -> Live -> [Live] Source # enumFromThenTo :: Live -> Live -> Live -> [Live] Source #
Show Live Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> Live -> ShowS Source # show :: Live -> String Source # showList :: [Live] -> ShowS Source #
Eq Live Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: Live -> Live -> Bool Source # (/=) :: Live -> Live -> Bool Source #
Ord Live Source # |
Instance details Defined in GI.Atk.Enums Methods compare :: Live -> Live -> Ordering Source # (<) :: Live -> Live -> Bool Source # (<=) :: Live -> Live -> Bool Source # (>) :: Live -> Live -> Bool Source # (>=) :: Live -> Live -> Bool Source # max :: Live -> Live -> Live Source # min :: Live -> Live -> Live Source #
BoxedEnum Live Source # |
Instance details Defined in GI.Atk.Enums
TypedObject Live Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes Live Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes Live Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes Live = '[] :: [Type]

## RelationType

data RelationType Source #

Describes the type of the relation

Constructors

RelationTypeNull | Not used, represens "no relationship" or an error condition.
RelationTypeControlledBy | Indicates an object controlled by one or more target objects.
RelationTypeControllerFor | Indicates an object is an controller for one or more target objects.
RelationTypeLabelFor | Indicates an object is a label for one or more target objects.
RelationTypeLabelledBy | Indicates an object is labelled by one or more target objects.
RelationTypeMemberOf | Indicates an object is a member of a group of one or more target objects.
RelationTypeNodeChildOf | Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell.
RelationTypeFlowsTo | Indicates that the object has content that flows logically to another AtkObject in a sequential way, (for instance text-flow).
RelationTypeFlowsFrom | Indicates that the object has content that flows logically from another AtkObject in a sequential way, (for instance text-flow).
RelationTypeSubwindowOf | Indicates a subwindow attached to a component but otherwise has no connection in the UI heirarchy to that component.
RelationTypeEmbeds | Indicates that the object visually embeds another object's content, i.e. this object's content flows around another's content.
RelationTypeEmbeddedBy | Reciprocal of `RelationTypeEmbeds`, indicates that this object's content is visualy embedded in another object.
RelationTypePopupFor | Indicates that an object is a popup for another object.
RelationTypeParentWindowOf | Indicates that an object is a parent window of another object.

RelationTypeDescribedBy

Reciprocal of `RelationTypeDescriptionFor`. Indicates that one or more target objects provide descriptive information about this object. This relation type is most appropriate for information that is not essential as its presentation may be user-configurable and/or limited to an on-demand mechanism such as an assistive technology command. For brief, essential information such as can be found in a widget's on-screen label, use `RelationTypeLabelledBy`. For an on-screen error message, use `RelationTypeErrorMessage`. For lengthy extended descriptive information contained in an on-screen object, consider using `RelationTypeDetails` as assistive technologies may provide a means for the user to navigate to objects containing detailed descriptions so that their content can be more closely reviewed.

RelationTypeDescriptionFor | Reciprocal of `RelationTypeDescribedBy`. Indicates that this object provides descriptive information about the target object(s). See also `RelationTypeDetailsFor` and `RelationTypeErrorFor`.
RelationTypeNodeParentOf | Indicates an object is a cell in a treetable and is expanded to display other cells in the same column.

RelationTypeDetails

Reciprocal of `RelationTypeDetailsFor`. Indicates that this object has a detailed or extended description, the contents of which can be found in the target object(s). This relation type is most appropriate for information that is sufficiently lengthy as to make navigation to the container of that information desirable. For less verbose information suitable for announcement only, see `RelationTypeDescribedBy`. If the detailed information describes an error condition, `RelationTypeErrorFor` should be used instead. `since`: ATK-2.26.

RelationTypeDetailsFor | Reciprocal of `RelationTypeDetails`. Indicates that this object provides a detailed or extended description about the target object(s). See also `RelationTypeDescriptionFor` and `RelationTypeErrorFor`. `since`: ATK-2.26.
RelationTypeErrorMessage | Reciprocal of `RelationTypeErrorFor`. Indicates that this object has one or more errors, the nature of which is described in the contents of the target object(s). Objects that have this relation type should also contain `StateTypeInvalidEntry` in their `StateSet`. `since`: ATK-2.26.
RelationTypeErrorFor | Reciprocal of `RelationTypeErrorMessage`. Indicates that this object contains an error message describing an invalid condition in the target object(s). `since`: ATK_2.26.
RelationTypeLastDefined | Not used, this value indicates the end of the enumeration.
AnotherRelationType Int | Catch-all for unknown values

#### Instances

Instances details

Enum RelationType Source # |

Instance details

Defined in GI.Atk.Enums

Methods

succ :: RelationType -> RelationType Source #

pred :: RelationType -> RelationType Source #

toEnum :: Int -> RelationType Source #

fromEnum :: RelationType -> Int Source #

enumFrom :: RelationType -> [RelationType] Source #

enumFromThen :: RelationType -> RelationType -> [RelationType] Source #

enumFromTo :: RelationType -> RelationType -> [RelationType] Source #

enumFromThenTo :: RelationType -> RelationType -> RelationType -> [RelationType] Source #

Show RelationType Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> RelationType -> ShowS Source # show :: RelationType -> String Source # showList :: [RelationType] -> ShowS Source #
Eq RelationType Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: RelationType -> RelationType -> Bool Source # (/=) :: RelationType -> RelationType -> Bool Source #
Ord RelationType Source # |

Instance details

Defined in GI.Atk.Enums

Methods

compare :: RelationType -> RelationType -> Ordering Source #

(<) :: RelationType -> RelationType -> Bool Source #

(<=) :: RelationType -> RelationType -> Bool Source #

(>) :: RelationType -> RelationType -> Bool Source #

(>=) :: RelationType -> RelationType -> Bool Source #

max :: RelationType -> RelationType -> RelationType Source #

min :: RelationType -> RelationType -> RelationType Source #

BoxedEnum RelationType Source # |
Instance details Defined in GI.Atk.Enums
TypedObject RelationType Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes RelationType Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes RelationType Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes RelationType = '[] :: [Type]

## Role

data Role Source #

Describes the role of an object

These are the built-in enumerated roles that UI components can have in ATK. Other roles may be added at runtime, so an AtkRole >= `RoleLastDefined` is not necessarily an error.

Constructors

RoleInvalid | Invalid role
RoleAcceleratorLabel | A label which represents an accelerator
RoleAlert | An object which is an alert to the user. Assistive Technologies typically respond to ATK_ROLE_ALERT by reading the entire onscreen contents of containers advertising this role. Should be used for warning dialogs, etc.
RoleAnimation | An object which is an animated image
RoleArrow | An arrow in one of the four cardinal directions
RoleCalendar | An object that displays a calendar and allows the user to select a date
RoleCanvas | An object that can be drawn into and is used to trap events
RoleCheckBox | A choice that can be checked or unchecked and provides a separate indicator for the current state
RoleCheckMenuItem | A menu item with a check box
RoleColorChooser | A specialized dialog that lets the user choose a color
RoleColumnHeader | The header for a column of data
RoleComboBox | A collapsible list of choices the user can select from
RoleDateEditor | An object whose purpose is to allow a user to edit a date
RoleDesktopIcon | An inconifed internal frame within a DESKTOP_PANE
RoleDesktopFrame | A pane that supports internal frames and iconified versions of those internal frames
RoleDial | An object whose purpose is to allow a user to set a value
RoleDialog | A top level window with title bar and a border
RoleDirectoryPane | A pane that allows the user to navigate through and select the contents of a directory
RoleDrawingArea | An object used for drawing custom user interface elements
RoleFileChooser | A specialized dialog that lets the user choose a file
RoleFiller | A object that fills up space in a user interface
RoleFontChooser | A specialized dialog that lets the user choose a font
RoleFrame | A top level window with a title bar, border, menubar, etc.
RoleGlassPane | A pane that is guaranteed to be painted on top of all panes beneath it
RoleHtmlContainer | A document container for HTML, whose children represent the document content
RoleIcon | A small fixed size picture, typically used to decorate components
RoleImage | An object whose primary purpose is to display an image
RoleInternalFrame | A frame-like object that is clipped by a desktop pane
RoleLabel | An object used to present an icon or short string in an interface
RoleLayeredPane | A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
RoleList | An object that presents a list of objects to the user and allows the user to select one or more of them
RoleListItem | An object that represents an element of a list
RoleMenu | An object usually found inside a menu bar that contains a list of actions the user can choose from
RoleMenuBar | An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from
RoleMenuItem | An object usually contained in a menu that presents an action the user can choose
RoleOptionPane | A specialized pane whose primary use is inside a DIALOG
RolePageTab | An object that is a child of a page tab list
RolePageTabList | An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object
RolePanel | A generic container that is often used to group objects
RolePasswordText | A text object uses for passwords, or other places where the text content is not shown visibly to the user
RolePopupMenu | A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices
RoleProgressBar | An object used to indicate how much of a task has been completed
RoleButton | An object the user can manipulate to tell the application to do something
RoleRadioButton | A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked
RoleRadioMenuItem | A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected
RoleRootPane | A specialized pane that has a glass pane and a layered pane as its children
RoleRowHeader | The header for a row of data
RoleScrollBar | An object usually used to allow a user to incrementally view a large amount of data.
RoleScrollPane | An object that allows a user to incrementally view a large amount of information
RoleSeparator | An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
RoleSlider | An object that allows the user to select from a bounded range
RoleSplitPane | A specialized panel that presents two other panels at the same time
RoleSpinButton | An object used to get an integer or floating point number from the user
RoleStatusbar | An object which reports messages of minor importance to the user
RoleTable | An object used to represent information in terms of rows and columns
RoleTableCell | A cell in a table
RoleTableColumnHeader | The header for a column of a table
RoleTableRowHeader | The header for a row of a table
RoleTearOffMenuItem | A menu item used to tear off and reattach its menu
RoleTerminal | An object that represents an accessible terminal. (Since: 0.6)

RoleText

An interactive widget that supports multiple lines of text and optionally accepts user input, but whose purpose is not to solicit user input. Thus ATK_ROLE_TEXT is appropriate for the text view in a plain text editor but inappropriate for an input field in a dialog box or web form. For widgets whose purpose is to solicit input from the user, see ATK_ROLE_ENTRY and ATK_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount of textual information, see ATK_ROLE_STATIC.

RoleToggleButton | A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state
RoleToolBar | A bar or palette usually composed of push buttons or toggle buttons
RoleToolTip | An object that provides information about another object
RoleTree | An object used to represent hierarchical information to the user
RoleTreeTable | An object capable of expanding and collapsing rows as well as showing multiple columns of data. (Since: 0.7)
RoleUnknown | The object contains some Accessible information, but its role is not known
RoleViewport | An object usually used in a scroll pane
RoleWindow | A top level window with no title or border.
RoleHeader | An object that serves as a document header. (Since: 1.1.1)
RoleFooter | An object that serves as a document footer. (Since: 1.1.1)
RoleParagraph | An object which is contains a paragraph of text content. (Since: 1.1.1)
RoleRuler | An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such). (Since: 1.1.1)
RoleApplication | The object is an application object, which may contain `aTKROLEFRAME` objects or other types of accessibles. The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION. (Since: 1.1.4)
RoleAutocomplete | The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry. (Since: 1.3)
RoleEditBar | The object is an editable text object in a toolbar. (Since: 1.5)
RoleEmbedded | The object is an embedded container within a document or panel. This role is a grouping "hint" indicating that the contained objects share a context. (Since: 1.7.2)
RoleEntry | The object is a component whose textual content may be entered or modified by the user, provided `aTKSTATEEDITABLE` is present. (Since: 1.11)
RoleChart | The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property. (Since: 1.11)
RoleCaption | The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. (Since: 1.11)
RoleDocumentFrame | The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface. (Since: 1.11)
RoleHeading | The object serves as a heading for content which follows it in a document. The 'heading level' of the heading, if availabe, may be obtained by querying the object's attributes.
RolePage | The object is a containing instance which encapsulates a page of information. `aTKROLEPAGE` is used in documents and content which support a paginated navigation model. (Since: 1.11)
RoleSection | The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections may be nested. (Since: 1.11)
RoleRedundantObject | The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should normally be ignored by clients. (Since: 1.11)
RoleForm | The object is a container for form controls, for instance as part of a web form or user-input form within a document. This role is primarily a tag/convenience for clients when navigating complex documents, it is not expected that ordinary GUI containers will always have ATK_ROLE_FORM. (Since: 1.12.0)
RoleLink | The object is a hypertext anchor, i.e. a "link" in a hypertext document. Such objects are distinct from 'inline' content which may also use the Hypertext/Hyperlink interfaces to indicate the range/location within a text object where an inline or embedded object lies. (Since: 1.12.1)
RoleInputMethodWindow | The object is a window or similar viewport which is used to allow composition or input of a 'complex character', in other words it is an "input method window." (Since: 1.12.1)
RoleTableRow | A row in a table. (Since: 2.1.0)
RoleTreeItem | An object that represents an element of a tree. (Since: 2.1.0)
RoleDocumentSpreadsheet | A document frame which contains a spreadsheet. (Since: 2.1.0)
RoleDocumentPresentation | A document frame which contains a presentation or slide content. (Since: 2.1.0)
RoleDocumentText | A document frame which contains textual content, such as found in a word processing application. (Since: 2.1.0)
RoleDocumentWeb | A document frame which contains HTML or other markup suitable for display in a web browser. (Since: 2.1.0)
RoleDocumentEmail | A document frame which contains email content to be displayed or composed either in plain text or HTML. (Since: 2.1.0)
RoleComment | An object found within a document and designed to present a comment, note, or other annotation. In some cases, this object might not be visible until activated. (Since: 2.1.0)
RoleListBox | A non-collapsible list of choices the user can select from. (Since: 2.1.0)
RoleGrouping | A group of related widgets. This group typically has a label. (Since: 2.1.0)
RoleImageMap | An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document. (Since: 2.1.0)
RoleNotification | A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application. (Since: 2.1.0)
RoleInfoBar | An object designed to present a message to the user within an existing window. (Since: 2.1.0)
RoleLevelBar | A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery. (Since: 2.7.3)
RoleTitleBar | A bar that serves as the title of a window or a dialog. (Since: 2.12)
RoleBlockQuote | An object which contains a text section that is quoted from another source. (Since: 2.12)
RoleAudio | An object which represents an audio element. (Since: 2.12)
RoleVideo | An object which represents a video element. (Since: 2.12)
RoleDefinition | A definition of a term or concept. (Since: 2.12)
RoleArticle | A section of a page that consists of a composition that forms an independent part of a document, page, or site. Examples: A blog entry, a news story, a forum post. (Since: 2.12)
RoleLandmark | A region of a web page intended as a navigational landmark. This is designed to allow Assistive Technologies to provide quick navigation among key regions within a document. (Since: 2.12)
RoleLog | A text widget or container holding log content, such as chat history and error logs. In this role there is a relationship between the arrival of new items in the log and the reading order. The log contains a meaningful sequence and new information is added only to the end of the log, not at arbitrary points. (Since: 2.12)
RoleMarquee | A container where non-essential information changes frequently. Common usages of marquee include stock tickers and ad banners. The primary difference between a marquee and a log is that logs usually have a meaningful order or sequence of important content changes. (Since: 2.12)
RoleMath | A text widget or container that holds a mathematical expression. (Since: 2.12)
RoleRating | A widget whose purpose is to display a rating, such as the number of stars associated with a song in a media player. Objects of this role should also implement AtkValue. (Since: 2.12)
RoleTimer | An object containing a numerical counter which indicates an amount of elapsed time from a start point, or the time remaining until an end point. (Since: 2.12)
RoleDescriptionList | An object that represents a list of term-value groups. A term-value group represents a individual description and consist of one or more names (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values (ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be more than one group with the same term name. (Since: 2.12)
RoleDescriptionTerm | An object that represents a term or phrase with a corresponding definition. (Since: 2.12)
RoleDescriptionValue | An object that represents the description, definition or value of a term. (Since: 2.12)

RoleStatic

A generic non-container object whose purpose is to display a brief amount of information to the user and whose role is known by the implementor but lacks semantic value for the user. Examples in which `RoleStatic` is appropriate include the message displayed in a message box and an image used as an alternative means to display text. `RoleStatic` should not be applied to widgets which are traditionally interactive, objects which display a significant amount of content, or any object which has an accessible relation pointing to another object. Implementors should expose the displayed information through the accessible name of the object. If doing so seems inappropriate, it may indicate that a different role should be used. For labels which describe another widget, see `RoleLabel`. For text views, see `RoleText`. For generic containers, see `RolePanel`. For objects whose role is not known by the implementor, see `RoleUnknown`. (Since: 2.16)

RoleMathFraction | An object that represents a mathematical fraction. (Since: 2.16)
RoleMathRoot | An object that represents a mathematical expression displayed with a radical. (Since: 2.16)
RoleSubscript | An object that contains text that is displayed as a subscript. (Since: 2.16)
RoleSuperscript | An object that contains text that is displayed as a superscript. (Since: 2.16)
RoleFootnote | An object that contains the text of a footnote. (Since: 2.26)
RoleContentDeletion | Content previously deleted or proposed to be deleted, e.g. in revision history or a content view providing suggestions from reviewers. (Since: 2.34)
RoleContentInsertion | Content previously inserted or proposed to be inserted, e.g. in revision history or a content view providing suggestions from reviewers. (Since: 2.34)

RoleMark

A run of content that is marked or highlighted, such as for reference purposes, or to call it out as having a special purpose. If the marked content has an associated section in the document elaborating on the reason for the mark, then `RelationTypeDetails` should be used on the mark to point to that associated section. In addition, the reciprocal relation `RelationTypeDetailsFor` should be used on the associated content section to point back to the mark. (Since: 2.36)

RoleSuggestion | A container for content that is called out as a proposed change from the current version of the document, such as by a reviewer of the content. This role should include either `RoleContentDeletion` and/or `RoleContentInsertion` children, in any order, to indicate what the actual change is. (Since: 2.36)
RolePushButtonMenu | A specialized push button to open a menu. (Since: 2.46)
RoleLastDefined | not a valid role, used for finding end of the enumeration
RolePushButton | No description available in the introspection data.
AnotherRole Int | Catch-all for unknown values

#### Instances

Instances details

Enum Role Source # |
Instance details Defined in GI.Atk.Enums Methods succ :: Role -> Role Source # pred :: Role -> Role Source # toEnum :: Int -> Role Source # fromEnum :: Role -> Int Source # enumFrom :: Role -> [Role] Source # enumFromThen :: Role -> Role -> [Role] Source # enumFromTo :: Role -> Role -> [Role] Source # enumFromThenTo :: Role -> Role -> Role -> [Role] Source #
Show Role Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> Role -> ShowS Source # show :: Role -> String Source # showList :: [Role] -> ShowS Source #
Eq Role Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: Role -> Role -> Bool Source # (/=) :: Role -> Role -> Bool Source #
Ord Role Source # |
Instance details Defined in GI.Atk.Enums Methods compare :: Role -> Role -> Ordering Source # (<) :: Role -> Role -> Bool Source # (<=) :: Role -> Role -> Bool Source # (>) :: Role -> Role -> Bool Source # (>=) :: Role -> Role -> Bool Source # max :: Role -> Role -> Role Source # min :: Role -> Role -> Role Source #
BoxedEnum Role Source # |
Instance details Defined in GI.Atk.Enums
TypedObject Role Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes Role Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes Role Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes Role = '[] :: [Type]

## ScrollType

data ScrollType Source #

Specifies where an object should be placed on the screen when using scroll_to.

Since: 2.30

Constructors

ScrollTypeTopLeft | Scroll the object vertically and horizontally to bring its top left corner to the top left corner of the window.
ScrollTypeBottomRight | Scroll the object vertically and horizontally to bring its bottom right corner to the bottom right corner of the window.
ScrollTypeTopEdge | Scroll the object vertically to bring its top edge to the top edge of the window.
ScrollTypeBottomEdge | Scroll the object vertically to bring its bottom edge to the bottom edge of the window.
ScrollTypeLeftEdge | Scroll the object vertically and horizontally to bring its left edge to the left edge of the window.
ScrollTypeRightEdge | Scroll the object vertically and horizontally to bring its right edge to the right edge of the window.
ScrollTypeAnywhere | Scroll the object vertically and horizontally so that as much as possible of the object becomes visible. The exact placement is determined by the application.
AnotherScrollType Int | Catch-all for unknown values

#### Instances

Instances details

Enum ScrollType Source # |

Instance details

Defined in GI.Atk.Enums

Methods

succ :: ScrollType -> ScrollType Source #

pred :: ScrollType -> ScrollType Source #

toEnum :: Int -> ScrollType Source #

fromEnum :: ScrollType -> Int Source #

enumFrom :: ScrollType -> [ScrollType] Source #

enumFromThen :: ScrollType -> ScrollType -> [ScrollType] Source #

enumFromTo :: ScrollType -> ScrollType -> [ScrollType] Source #

enumFromThenTo :: ScrollType -> ScrollType -> ScrollType -> [ScrollType] Source #

Show ScrollType Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> ScrollType -> ShowS Source # show :: ScrollType -> String Source # showList :: [ScrollType] -> ShowS Source #
Eq ScrollType Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: ScrollType -> ScrollType -> Bool Source # (/=) :: ScrollType -> ScrollType -> Bool Source #
Ord ScrollType Source # |

Instance details

Defined in GI.Atk.Enums

Methods

compare :: ScrollType -> ScrollType -> Ordering Source #

(<) :: ScrollType -> ScrollType -> Bool Source #

(<=) :: ScrollType -> ScrollType -> Bool Source #

(>) :: ScrollType -> ScrollType -> Bool Source #

(>=) :: ScrollType -> ScrollType -> Bool Source #

max :: ScrollType -> ScrollType -> ScrollType Source #

min :: ScrollType -> ScrollType -> ScrollType Source #

BoxedEnum ScrollType Source # |
Instance details Defined in GI.Atk.Enums
TypedObject ScrollType Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes ScrollType Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes ScrollType Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes ScrollType = '[] :: [Type]

## StateType

data StateType Source #

The possible types of states of an object

Constructors

StateTypeInvalid | Indicates an invalid state - probably an error condition.

StateTypeActive

Indicates a window is currently the active window, or an object is the active subelement within a container or table. ATK_STATE_ACTIVE should not be used for objects which have ATK_STATE_FOCUSABLE or ATK_STATE_SELECTABLE: Those objects should use ATK_STATE_FOCUSED and ATK_STATE_SELECTED respectively. ATK_STATE_ACTIVE is a means to indicate that an object which is not focusable and not selectable is the currently-active item within its parent container.

StateTypeArmed | Indicates that the object is 'armed', i.e. will be activated by if a pointer button-release event occurs within its bounds. Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation. ATK_STATE_ARMED has been deprecated since ATK-2.16 and should not be used in newly-written code.

StateTypeBusy

Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. This state may be used by implementors of Document to indicate that content loading is underway. It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed.

StateTypeChecked | Indicates this object is currently checked, for instance a checkbox is 'non-empty'.
StateTypeDefunct | Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed)

StateTypeEditable

Indicates that this object can contain text, and that the user can change the textual contents of this object by editing those contents directly. For an object which is expected to be editable due to its type, but which cannot be edited due to the application or platform preventing the user from doing so, that object's `StateSet` should lack ATK_STATE_EDITABLE and should contain ATK_STATE_READ_ONLY.

StateTypeEnabled | Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE
StateTypeExpandable | Indicates this object allows progressive disclosure of its children
StateTypeExpanded | Indicates this object its expanded - see ATK_STATE_EXPANDABLE above
StateTypeFocusable | Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus
StateTypeFocused | Indicates this object currently has the keyboard focus
StateTypeHorizontal | Indicates the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR. For objects where vertical/horizontal orientation is especially meaningful.
StateTypeIconified | Indicates this object is minimized and is represented only by an icon
StateTypeModal | Indicates something must be done with this object before the user can interact with an object in a different window
StateTypeMultiLine | Indicates this (text) object can contain multiple lines of text
StateTypeMultiselectable | Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections.
StateTypeOpaque | Indicates this object paints every pixel within its rectangular region.
StateTypePressed | Indicates this object is currently pressed.
StateTypeResizable | Indicates the size of this object is not fixed
StateTypeSelectable | Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected
StateTypeSelected | Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected

StateTypeSensitive

Indicates this object is sensitive, e.g. to user interaction. STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls, but may be found in the absence of STATE_ENABLED if the current visible state of the control is "disconnected" from the application state. In such cases, direct user interaction can often result in the object gaining STATE_SENSITIVE, for instance if a user makes an explicit selection using an object whose current state is ambiguous or undefined. `see` STATE_ENABLED, STATE_INDETERMINATE.

StateTypeShowing | Indicates this object, the object's parent, the object's parent's parent, and so on, are all 'shown' to the end-user, i.e. subject to "exposure" if blocking or obscuring objects do not interpose between this object and the top of the window stack.
StateTypeSingleLine | Indicates this (text) object can contain only a single line of text

StateTypeStale

Indicates that the information returned for this object may no longer be synchronized with the application state. This is implied if the object has STATE_TRANSIENT, and can also occur towards the end of the object peer's lifecycle. It can also be used to indicate that the index associated with this object has changed since the user accessed the object (in lieu of "index-in-parent-changed" events).

StateTypeTransient | Indicates this object is transient, i.e. a snapshot which may not emit events when its state changes. Data from objects with ATK_STATE_TRANSIENT should not be cached, since there may be no notification given when the cached data becomes obsolete.
StateTypeVertical | Indicates the orientation of this object is vertical

StateTypeVisible

Indicates this object is visible, e.g. has been explicitly marked for exposure to the user. **note**: `StateTypeVisible` is no guarantee that the object is actually unobscured on the screen, only that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the field of view, or having an ancestor container that has not yet made visible. A widget is potentially onscreen if it has both `StateTypeVisible` and `StateTypeShowing`. The absence of `StateTypeVisible` and `StateTypeShowing` is semantically equivalent to saying that an object is 'hidden'. See also `StateTypeTruncated`, which applies if an object with `StateTypeVisible` and `StateTypeShowing` set lies within a viewport which means that its contents are clipped, e.g. a truncated spreadsheet cell or an image within a scrolling viewport. Mostly useful for screen-review and magnification algorithms.

StateTypeManagesDescendants

Indicates that "active-descendant-changed" event is sent when children become 'active' (i.e. are selected or navigated to onscreen). Used to prevent need to enumerate all children in very large containers, like tables. The presence of STATE_MANAGES_DESCENDANTS is an indication to the client. that the children should not, and need not, be enumerated by the client. Objects implementing this state are expected to provide relevant state notifications to listening clients, for instance notifications of visibility changes and activation of their contained child objects, without the client having previously requested references to those children.

StateTypeIndeterminate

Indicates that the value, or some other quantifiable property, of this AtkObject cannot be fully determined. In the case of a large data set in which the total number of items in that set is unknown (e.g. 1 of 999+), implementors should expose the currently-known set size (999) along with this state. In the case of a check box, this state should be used to indicate that the check box is a tri-state check box which is currently neither checked nor unchecked.

StateTypeTruncated | Indicates that an object is truncated, e.g. a text value in a speradsheet cell.
StateTypeRequired | Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface.
StateTypeInvalidEntry | Indicates that the object has encountered an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input.

StateTypeSupportsAutocompletion

Indicates that the object in question implements some form of ¨typeahead¨ or pre-selection behavior whereby entering the first character of one or more sub-elements causes those elements to scroll into view or become selected. Subsequent character input may narrow the selection further as long as one or more sub-elements match the string. This state is normally only useful and encountered on objects that implement Selection. In some cases the typeahead behavior may result in full or partial ¨completion¨ of the data in the input field, in which case these input events may trigger text-changed events from the AtkText interface. This state supplants `aTKROLEAUTOCOMPLETE`.

StateTypeSelectableText

Indicates that the object in question supports text selection. It should only be exposed on objects which implement the Text interface, in order to distinguish this state from `aTKSTATESELECTABLE`, which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations.

StateTypeDefault | Indicates that the object is the "default" active component, i.e. the object which is activated by an end-user press of the "Enter" or "Return" key. Typically a "close" or "submit" button.

StateTypeAnimated

Indicates that the object changes its appearance dynamically as an inherent part of its presentation. This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation. **note**: some applications, notably content viewers, may not be able to detect all kinds of animated content. Therefore the absence of this state should not be taken as definitive evidence that the object's visual representation is static; this state is advisory.

StateTypeVisited | Indicates that the object (typically a hyperlink) has already been 'activated', and/or its backing data has already been downloaded, rendered, or otherwise "visited".
StateTypeCheckable | Indicates this object has the potential to be checked, such as a checkbox or toggle-able table cell. `since`: ATK-2.12
StateTypeHasPopup | Indicates that the object has a popup context menu or sub-level menu which may or may not be showing. This means that activation renders conditional content. Note that ordinary tooltips are not considered popups in this context. `since`: ATK-2.12
StateTypeHasTooltip | Indicates this object has a tooltip. `since`: ATK-2.16

StateTypeReadOnly

Indicates that a widget which is ENABLED and SENSITIVE has a value which can be read, but not modified, by the user. Note that this state should only be applied to widget types whose value is normally directly user modifiable, such as check boxes, radio buttons, spin buttons, text input fields, and combo boxes, as a means to convey that the expected interaction with that widget is not possible. When the expected interaction with a widget does not include modification by the user, as is the case with labels and containers, ATK_STATE_READ_ONLY should not be applied. See also ATK_STATE_EDITABLE. `since`: ATK-2-16

StateTypeCollapsed | Indicates this object is collapsed. `since`: ATK-2.38
StateTypeLastDefined | Not a valid state, used for finding end of enumeration
AnotherStateType Int | Catch-all for unknown values

#### Instances

Instances details

Enum StateType Source # |

Instance details

Defined in GI.Atk.Enums

Methods

succ :: StateType -> StateType Source #

pred :: StateType -> StateType Source #

toEnum :: Int -> StateType Source #

fromEnum :: StateType -> Int Source #

enumFrom :: StateType -> [StateType] Source #

enumFromThen :: StateType -> StateType -> [StateType] Source #

enumFromTo :: StateType -> StateType -> [StateType] Source #

enumFromThenTo :: StateType -> StateType -> StateType -> [StateType] Source #

Show StateType Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> StateType -> ShowS Source # show :: StateType -> String Source # showList :: [StateType] -> ShowS Source #
Eq StateType Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: StateType -> StateType -> Bool Source # (/=) :: StateType -> StateType -> Bool Source #
Ord StateType Source # |
Instance details Defined in GI.Atk.Enums Methods compare :: StateType -> StateType -> Ordering Source # (<) :: StateType -> StateType -> Bool Source # (<=) :: StateType -> StateType -> Bool Source # (>) :: StateType -> StateType -> Bool Source # (>=) :: StateType -> StateType -> Bool Source # max :: StateType -> StateType -> StateType Source # min :: StateType -> StateType -> StateType Source #
BoxedEnum StateType Source # |
Instance details Defined in GI.Atk.Enums
TypedObject StateType Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes StateType Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes StateType Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes StateType = '[] :: [Type]

## TextAttribute

data TextAttribute Source #

Describes the text attributes supported

Constructors

TextAttributeInvalid | Invalid attribute, like bad spelling or grammar.
TextAttributeLeftMargin | The pixel width of the left margin
TextAttributeRightMargin | The pixel width of the right margin
TextAttributeIndent | The number of pixels that the text is indented
TextAttributeInvisible | Either "true" or "false" indicating whether text is visible or not
TextAttributeEditable | Either "true" or "false" indicating whether text is editable or not
TextAttributePixelsAboveLines | Pixels of blank space to leave above each newline-terminated line.
TextAttributePixelsBelowLines | Pixels of blank space to leave below each newline-terminated line.
TextAttributePixelsInsideWrap | Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph).
TextAttributeBgFullHeight | "true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character.
TextAttributeRise | Number of pixels that the characters are risen above the baseline. See also ATK_TEXT_ATTR_TEXT_POSITION.
TextAttributeUnderline | "none", "single", "double", "low", or "error"
TextAttributeStrikethrough | "true" or "false" whether the text is strikethrough
TextAttributeSize | The size of the characters in points. eg: 10
TextAttributeScale | The scale of the characters. The value is a string representation of a double
TextAttributeWeight | The weight of the characters.
TextAttributeLanguage | The language used
TextAttributeFamilyName | The font family name
TextAttributeBgColor | The background color. The value is an RGB value of the format "`u`,`u`,`u`"
TextAttributeFgColor | The foreground color. The value is an RGB value of the format "`u`,`u`,`u`"
TextAttributeBgStipple | "true" if a `GdkBitmap` is set for stippling the background color.
TextAttributeFgStipple | "true" if a `GdkBitmap` is set for stippling the foreground color.
TextAttributeWrapMode | The wrap mode of the text, if any. Values are "none", "char", "word", or "word_char".
TextAttributeDirection | The direction of the text, if set. Values are "none", "ltr" or "rtl"
TextAttributeJustification | The justification of the text, if set. Values are "left", "right", "center" or "fill"
TextAttributeStretch | The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded"
TextAttributeVariant | The capitalization variant of the text, if set. Values are "normal" or "small_caps"
TextAttributeStyle | The slant style of the text, if set. Values are "normal", "oblique" or "italic"
TextAttributeTextPosition | The vertical position with respect to the baseline. Values are "baseline", "super", or "sub". Note that a super or sub text attribute refers to position with respect to the baseline of the prior character.
TextAttributeLastDefined | not a valid text attribute, used for finding end of enumeration
AnotherTextAttribute Int | Catch-all for unknown values

#### Instances

Instances details

Enum TextAttribute Source # |

Instance details

Defined in GI.Atk.Enums

Methods

succ :: TextAttribute -> TextAttribute Source #

pred :: TextAttribute -> TextAttribute Source #

toEnum :: Int -> TextAttribute Source #

fromEnum :: TextAttribute -> Int Source #

enumFrom :: TextAttribute -> [TextAttribute] Source #

enumFromThen :: TextAttribute -> TextAttribute -> [TextAttribute] Source #

enumFromTo :: TextAttribute -> TextAttribute -> [TextAttribute] Source #

enumFromThenTo :: TextAttribute -> TextAttribute -> TextAttribute -> [TextAttribute] Source #

Show TextAttribute Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> TextAttribute -> ShowS Source # show :: TextAttribute -> String Source # showList :: [TextAttribute] -> ShowS Source #
Eq TextAttribute Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: TextAttribute -> TextAttribute -> Bool Source # (/=) :: TextAttribute -> TextAttribute -> Bool Source #
Ord TextAttribute Source # |

Instance details

Defined in GI.Atk.Enums

Methods

compare :: TextAttribute -> TextAttribute -> Ordering Source #

(<) :: TextAttribute -> TextAttribute -> Bool Source #

(<=) :: TextAttribute -> TextAttribute -> Bool Source #

(>) :: TextAttribute -> TextAttribute -> Bool Source #

(>=) :: TextAttribute -> TextAttribute -> Bool Source #

max :: TextAttribute -> TextAttribute -> TextAttribute Source #

min :: TextAttribute -> TextAttribute -> TextAttribute Source #

BoxedEnum TextAttribute Source # |
Instance details Defined in GI.Atk.Enums
TypedObject TextAttribute Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes TextAttribute Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes TextAttribute Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes TextAttribute = '[] :: [Type]

## TextBoundary

data TextBoundary Source #

Text boundary types used for specifying boundaries for regions of text. This enumeration is deprecated since 2.9.4 and should not be used. Use AtkTextGranularity with `atk_text_get_string_at_offset` instead.

Constructors

TextBoundaryChar | Boundary is the boundary between characters (including non-printing characters)
TextBoundaryWordStart | Boundary is the start (i.e. first character) of a word.
TextBoundaryWordEnd | Boundary is the end (i.e. last character) of a word.
TextBoundarySentenceStart | Boundary is the first character in a sentence.
TextBoundarySentenceEnd | Boundary is the last (terminal) character in a sentence; in languages which use "sentence stop" punctuation such as English, the boundary is thus the '.', '?', or similar terminal punctuation character.
TextBoundaryLineStart | Boundary is the initial character of the content or a character immediately following a newline, linefeed, or return character.
TextBoundaryLineEnd | Boundary is the linefeed, or return character.
AnotherTextBoundary Int | Catch-all for unknown values

#### Instances

Instances details

Enum TextBoundary Source # |

Instance details

Defined in GI.Atk.Enums

Methods

succ :: TextBoundary -> TextBoundary Source #

pred :: TextBoundary -> TextBoundary Source #

toEnum :: Int -> TextBoundary Source #

fromEnum :: TextBoundary -> Int Source #

enumFrom :: TextBoundary -> [TextBoundary] Source #

enumFromThen :: TextBoundary -> TextBoundary -> [TextBoundary] Source #

enumFromTo :: TextBoundary -> TextBoundary -> [TextBoundary] Source #

enumFromThenTo :: TextBoundary -> TextBoundary -> TextBoundary -> [TextBoundary] Source #

Show TextBoundary Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> TextBoundary -> ShowS Source # show :: TextBoundary -> String Source # showList :: [TextBoundary] -> ShowS Source #
Eq TextBoundary Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: TextBoundary -> TextBoundary -> Bool Source # (/=) :: TextBoundary -> TextBoundary -> Bool Source #
Ord TextBoundary Source # |

Instance details

Defined in GI.Atk.Enums

Methods

compare :: TextBoundary -> TextBoundary -> Ordering Source #

(<) :: TextBoundary -> TextBoundary -> Bool Source #

(<=) :: TextBoundary -> TextBoundary -> Bool Source #

(>) :: TextBoundary -> TextBoundary -> Bool Source #

(>=) :: TextBoundary -> TextBoundary -> Bool Source #

max :: TextBoundary -> TextBoundary -> TextBoundary Source #

min :: TextBoundary -> TextBoundary -> TextBoundary Source #

BoxedEnum TextBoundary Source # |
Instance details Defined in GI.Atk.Enums
TypedObject TextBoundary Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes TextBoundary Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes TextBoundary Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes TextBoundary = '[] :: [Type]

## TextClipType

data TextClipType Source #

Describes the type of clipping required.

Constructors

TextClipTypeNone | No clipping to be done
TextClipTypeMin | Text clipped by min coordinate is omitted
TextClipTypeMax | Text clipped by max coordinate is omitted
TextClipTypeBoth | Only text fully within mix/max bound is retained
AnotherTextClipType Int | Catch-all for unknown values

#### Instances

Instances details

Enum TextClipType Source # |

Instance details

Defined in GI.Atk.Enums

Methods

succ :: TextClipType -> TextClipType Source #

pred :: TextClipType -> TextClipType Source #

toEnum :: Int -> TextClipType Source #

fromEnum :: TextClipType -> Int Source #

enumFrom :: TextClipType -> [TextClipType] Source #

enumFromThen :: TextClipType -> TextClipType -> [TextClipType] Source #

enumFromTo :: TextClipType -> TextClipType -> [TextClipType] Source #

enumFromThenTo :: TextClipType -> TextClipType -> TextClipType -> [TextClipType] Source #

Show TextClipType Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> TextClipType -> ShowS Source # show :: TextClipType -> String Source # showList :: [TextClipType] -> ShowS Source #
Eq TextClipType Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: TextClipType -> TextClipType -> Bool Source # (/=) :: TextClipType -> TextClipType -> Bool Source #
Ord TextClipType Source # |

Instance details

Defined in GI.Atk.Enums

Methods

compare :: TextClipType -> TextClipType -> Ordering Source #

(<) :: TextClipType -> TextClipType -> Bool Source #

(<=) :: TextClipType -> TextClipType -> Bool Source #

(>) :: TextClipType -> TextClipType -> Bool Source #

(>=) :: TextClipType -> TextClipType -> Bool Source #

max :: TextClipType -> TextClipType -> TextClipType Source #

min :: TextClipType -> TextClipType -> TextClipType Source #

BoxedEnum TextClipType Source # |
Instance details Defined in GI.Atk.Enums
TypedObject TextClipType Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes TextClipType Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes TextClipType Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes TextClipType = '[] :: [Type]

## TextGranularity

data TextGranularity Source #

Text granularity types used for specifying the granularity of the region of text we are interested in.

Constructors

TextGranularityChar | Granularity is defined by the boundaries between characters (including non-printing characters)
TextGranularityWord | Granularity is defined by the boundaries of a word, starting at the beginning of the current word and finishing at the beginning of the following one, if present.
TextGranularitySentence | Granularity is defined by the boundaries of a sentence, starting at the beginning of the current sentence and finishing at the beginning of the following one, if present.
TextGranularityLine | Granularity is defined by the boundaries of a line, starting at the beginning of the current line and finishing at the beginning of the following one, if present.
TextGranularityParagraph | Granularity is defined by the boundaries of a paragraph, starting at the beginning of the current paragraph and finishing at the beginning of the following one, if present.
AnotherTextGranularity Int | Catch-all for unknown values

#### Instances

Instances details

Enum TextGranularity Source # |

Instance details

Defined in GI.Atk.Enums

Methods

succ :: TextGranularity -> TextGranularity Source #

pred :: TextGranularity -> TextGranularity Source #

toEnum :: Int -> TextGranularity Source #

fromEnum :: TextGranularity -> Int Source #

enumFrom :: TextGranularity -> [TextGranularity] Source #

enumFromThen :: TextGranularity -> TextGranularity -> [TextGranularity] Source #

enumFromTo :: TextGranularity -> TextGranularity -> [TextGranularity] Source #

enumFromThenTo :: TextGranularity -> TextGranularity -> TextGranularity -> [TextGranularity] Source #

Show TextGranularity Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> TextGranularity -> ShowS Source # show :: TextGranularity -> String Source # showList :: [TextGranularity] -> ShowS Source #
Eq TextGranularity Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: TextGranularity -> TextGranularity -> Bool Source # (/=) :: TextGranularity -> TextGranularity -> Bool Source #
Ord TextGranularity Source # |

Instance details

Defined in GI.Atk.Enums

Methods

compare :: TextGranularity -> TextGranularity -> Ordering Source #

(<) :: TextGranularity -> TextGranularity -> Bool Source #

(<=) :: TextGranularity -> TextGranularity -> Bool Source #

(>) :: TextGranularity -> TextGranularity -> Bool Source #

(>=) :: TextGranularity -> TextGranularity -> Bool Source #

max :: TextGranularity -> TextGranularity -> TextGranularity Source #

min :: TextGranularity -> TextGranularity -> TextGranularity Source #

BoxedEnum TextGranularity Source # |
Instance details Defined in GI.Atk.Enums
TypedObject TextGranularity Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes TextGranularity Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes TextGranularity Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes TextGranularity = '[] :: [Type]

## ValueType

data ValueType Source #

Default types for a given value. Those are defined in order to easily get localized strings to describe a given value or a given subrange, using `valueTypeGetLocalizedName`.

Constructors

ValueTypeVeryWeak | No description available in the introspection data.
ValueTypeWeak | No description available in the introspection data.
ValueTypeAcceptable | No description available in the introspection data.
ValueTypeStrong | No description available in the introspection data.
ValueTypeVeryStrong | No description available in the introspection data.
ValueTypeVeryLow | No description available in the introspection data.
ValueTypeLow | No description available in the introspection data.
ValueTypeMedium | No description available in the introspection data.
ValueTypeHigh | No description available in the introspection data.
ValueTypeVeryHigh | No description available in the introspection data.
ValueTypeVeryBad | No description available in the introspection data.
ValueTypeBad | No description available in the introspection data.
ValueTypeGood | No description available in the introspection data.
ValueTypeVeryGood | No description available in the introspection data.
ValueTypeBest | No description available in the introspection data.
ValueTypeLastDefined | No description available in the introspection data.
AnotherValueType Int | Catch-all for unknown values

#### Instances

Instances details

Enum ValueType Source # |

Instance details

Defined in GI.Atk.Enums

Methods

succ :: ValueType -> ValueType Source #

pred :: ValueType -> ValueType Source #

toEnum :: Int -> ValueType Source #

fromEnum :: ValueType -> Int Source #

enumFrom :: ValueType -> [ValueType] Source #

enumFromThen :: ValueType -> ValueType -> [ValueType] Source #

enumFromTo :: ValueType -> ValueType -> [ValueType] Source #

enumFromThenTo :: ValueType -> ValueType -> ValueType -> [ValueType] Source #

Show ValueType Source # |
Instance details Defined in GI.Atk.Enums Methods showsPrec :: Int -> ValueType -> ShowS Source # show :: ValueType -> String Source # showList :: [ValueType] -> ShowS Source #
Eq ValueType Source # |
Instance details Defined in GI.Atk.Enums Methods (==) :: ValueType -> ValueType -> Bool Source # (/=) :: ValueType -> ValueType -> Bool Source #
Ord ValueType Source # |
Instance details Defined in GI.Atk.Enums Methods compare :: ValueType -> ValueType -> Ordering Source # (<) :: ValueType -> ValueType -> Bool Source # (<=) :: ValueType -> ValueType -> Bool Source # (>) :: ValueType -> ValueType -> Bool Source # (>=) :: ValueType -> ValueType -> Bool Source # max :: ValueType -> ValueType -> ValueType Source # min :: ValueType -> ValueType -> ValueType Source #
BoxedEnum ValueType Source # |
Instance details Defined in GI.Atk.Enums
TypedObject ValueType Source # |
Instance details Defined in GI.Atk.Enums Methods glibType :: IO GType Source #
HasParentTypes ValueType Source # |
Instance details Defined in GI.Atk.Enums
type ParentTypes ValueType Source # |
Instance details Defined in GI.Atk.Enums type ParentTypes ValueType = '[] :: [Type]