GI.Atk.Enums

Enumerations

CoordType

data CoordType

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

Enum CoordType

Defined in GI.Atk.Enums

Methods

succ :: CoordType -> CoordType

pred :: CoordType -> CoordType

toEnum :: Int -> CoordType

fromEnum :: CoordType -> Int

enumFrom :: CoordType -> [CoordType]

enumFromThen :: CoordType -> CoordType -> [CoordType]

enumFromTo :: CoordType -> CoordType -> [CoordType]

enumFromThenTo :: CoordType -> CoordType -> CoordType -> [CoordType]

Eq CoordType

Defined in GI.Atk.Enums

Methods

(==) :: CoordType -> CoordType -> Bool

(/=) :: CoordType -> CoordType -> Bool

Ord CoordType

Defined in GI.Atk.Enums

Methods

compare :: CoordType -> CoordType -> Ordering

(<) :: CoordType -> CoordType -> Bool

(<=) :: CoordType -> CoordType -> Bool

(>) :: CoordType -> CoordType -> Bool

(>=) :: CoordType -> CoordType -> Bool

max :: CoordType -> CoordType -> CoordType

min :: CoordType -> CoordType -> CoordType

Show CoordType

Defined in GI.Atk.Enums

Methods

showsPrec :: Int -> CoordType -> ShowS

show :: CoordType -> String

showList :: [CoordType] -> ShowS

TypedObject CoordType

Defined in GI.Atk.Enums

Methods

glibType :: IO GType

BoxedEnum CoordType

Defined in GI.Atk.Enums

HasParentTypes CoordType

Defined in GI.Atk.Enums

type ParentTypes CoordType

Defined in GI.Atk.Enums

type ParentTypes CoordType = '[] :: [Type]

KeyEventType

data KeyEventType

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

Enum KeyEventType

Defined in GI.Atk.Enums

Methods

succ :: KeyEventType -> KeyEventType

pred :: KeyEventType -> KeyEventType

toEnum :: Int -> KeyEventType

fromEnum :: KeyEventType -> Int

enumFrom :: KeyEventType -> [KeyEventType]

enumFromThen :: KeyEventType -> KeyEventType -> [KeyEventType]

enumFromTo :: KeyEventType -> KeyEventType -> [KeyEventType]

enumFromThenTo :: KeyEventType -> KeyEventType -> KeyEventType -> [KeyEventType]

Eq KeyEventType

Defined in GI.Atk.Enums

Methods

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

(/=) :: KeyEventType -> KeyEventType -> Bool

Ord KeyEventType

Defined in GI.Atk.Enums

Methods

compare :: KeyEventType -> KeyEventType -> Ordering

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

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

(>) :: KeyEventType -> KeyEventType -> Bool

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

max :: KeyEventType -> KeyEventType -> KeyEventType

min :: KeyEventType -> KeyEventType -> KeyEventType

Show KeyEventType

Defined in GI.Atk.Enums

Methods

showsPrec :: Int -> KeyEventType -> ShowS

show :: KeyEventType -> String

showList :: [KeyEventType] -> ShowS

TypedObject KeyEventType

Defined in GI.Atk.Enums

Methods

glibType :: IO GType

BoxedEnum KeyEventType

Defined in GI.Atk.Enums

HasParentTypes KeyEventType

Defined in GI.Atk.Enums

type ParentTypes KeyEventType

Defined in GI.Atk.Enums

type ParentTypes KeyEventType = '[] :: [Type]

Layer

data Layer

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

Enum Layer

Defined in GI.Atk.Enums

Methods

succ :: Layer -> Layer

pred :: Layer -> Layer

toEnum :: Int -> Layer

fromEnum :: Layer -> Int

enumFrom :: Layer -> [Layer]

enumFromThen :: Layer -> Layer -> [Layer]

enumFromTo :: Layer -> Layer -> [Layer]

enumFromThenTo :: Layer -> Layer -> Layer -> [Layer]

Eq Layer

Defined in GI.Atk.Enums

Methods

(==) :: Layer -> Layer -> Bool

(/=) :: Layer -> Layer -> Bool

Ord Layer

Defined in GI.Atk.Enums

Methods

compare :: Layer -> Layer -> Ordering

(<) :: Layer -> Layer -> Bool

(<=) :: Layer -> Layer -> Bool

(>) :: Layer -> Layer -> Bool

(>=) :: Layer -> Layer -> Bool

max :: Layer -> Layer -> Layer

min :: Layer -> Layer -> Layer

Show Layer

Defined in GI.Atk.Enums

Methods

showsPrec :: Int -> Layer -> ShowS

show :: Layer -> String

showList :: [Layer] -> ShowS

TypedObject Layer

Defined in GI.Atk.Enums

Methods

glibType :: IO GType

BoxedEnum Layer

Defined in GI.Atk.Enums

HasParentTypes Layer

Defined in GI.Atk.Enums

type ParentTypes Layer

Defined in GI.Atk.Enums

type ParentTypes Layer = '[] :: [Type]

RelationType

data RelationType

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

Enum RelationType

Defined in GI.Atk.Enums

Methods

succ :: RelationType -> RelationType

pred :: RelationType -> RelationType

toEnum :: Int -> RelationType

fromEnum :: RelationType -> Int

enumFrom :: RelationType -> [RelationType]

enumFromThen :: RelationType -> RelationType -> [RelationType]

enumFromTo :: RelationType -> RelationType -> [RelationType]

enumFromThenTo :: RelationType -> RelationType -> RelationType -> [RelationType]

Eq RelationType

Defined in GI.Atk.Enums

Methods

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

(/=) :: RelationType -> RelationType -> Bool

Ord RelationType

Defined in GI.Atk.Enums

Methods

compare :: RelationType -> RelationType -> Ordering

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

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

(>) :: RelationType -> RelationType -> Bool

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

max :: RelationType -> RelationType -> RelationType

min :: RelationType -> RelationType -> RelationType

Show RelationType

Defined in GI.Atk.Enums

Methods

showsPrec :: Int -> RelationType -> ShowS

show :: RelationType -> String

showList :: [RelationType] -> ShowS

TypedObject RelationType

Defined in GI.Atk.Enums

Methods

glibType :: IO GType

BoxedEnum RelationType

Defined in GI.Atk.Enums

HasParentTypes RelationType

Defined in GI.Atk.Enums

type ParentTypes RelationType

Defined in GI.Atk.Enums

type ParentTypes RelationType = '[] :: [Type]

Role

data Role

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

RolePushButton

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)

RoleLastDefined

not a valid role, used for finding end of the enumeration

AnotherRole Int

Catch-all for unknown values

Instances

Enum Role

Defined in GI.Atk.Enums

Methods

succ :: Role -> Role

pred :: Role -> Role

toEnum :: Int -> Role

fromEnum :: Role -> Int

enumFrom :: Role -> [Role]

enumFromThen :: Role -> Role -> [Role]

enumFromTo :: Role -> Role -> [Role]

enumFromThenTo :: Role -> Role -> Role -> [Role]

Eq Role

Defined in GI.Atk.Enums

Methods

(==) :: Role -> Role -> Bool

(/=) :: Role -> Role -> Bool

Ord Role

Defined in GI.Atk.Enums

Methods

compare :: Role -> Role -> Ordering

(<) :: Role -> Role -> Bool

(<=) :: Role -> Role -> Bool

(>) :: Role -> Role -> Bool

(>=) :: Role -> Role -> Bool

max :: Role -> Role -> Role

min :: Role -> Role -> Role

Show Role

Defined in GI.Atk.Enums

Methods

showsPrec :: Int -> Role -> ShowS

show :: Role -> String

showList :: [Role] -> ShowS

TypedObject Role

Defined in GI.Atk.Enums

Methods

glibType :: IO GType

BoxedEnum Role

Defined in GI.Atk.Enums

HasParentTypes Role

Defined in GI.Atk.Enums

type ParentTypes Role

Defined in GI.Atk.Enums

type ParentTypes Role = '[] :: [Type]

ScrollType

data ScrollType

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

Enum ScrollType

Defined in GI.Atk.Enums

Methods

succ :: ScrollType -> ScrollType

pred :: ScrollType -> ScrollType

toEnum :: Int -> ScrollType

fromEnum :: ScrollType -> Int

enumFrom :: ScrollType -> [ScrollType]

enumFromThen :: ScrollType -> ScrollType -> [ScrollType]

enumFromTo :: ScrollType -> ScrollType -> [ScrollType]

enumFromThenTo :: ScrollType -> ScrollType -> ScrollType -> [ScrollType]

Eq ScrollType

Defined in GI.Atk.Enums

Methods

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

(/=) :: ScrollType -> ScrollType -> Bool

Ord ScrollType

Defined in GI.Atk.Enums

Methods

compare :: ScrollType -> ScrollType -> Ordering

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

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

(>) :: ScrollType -> ScrollType -> Bool

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

max :: ScrollType -> ScrollType -> ScrollType

min :: ScrollType -> ScrollType -> ScrollType

Show ScrollType

Defined in GI.Atk.Enums

Methods

showsPrec :: Int -> ScrollType -> ShowS

show :: ScrollType -> String

showList :: [ScrollType] -> ShowS

TypedObject ScrollType

Defined in GI.Atk.Enums

Methods

glibType :: IO GType

BoxedEnum ScrollType

Defined in GI.Atk.Enums

HasParentTypes ScrollType

Defined in GI.Atk.Enums

type ParentTypes ScrollType

Defined in GI.Atk.Enums

type ParentTypes ScrollType = '[] :: [Type]

StateType

data StateType

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

StateTypeLastDefined

Not a valid state, used for finding end of enumeration

AnotherStateType Int

Catch-all for unknown values

Instances

Enum StateType

Defined in GI.Atk.Enums

Methods

succ :: StateType -> StateType

pred :: StateType -> StateType

toEnum :: Int -> StateType

fromEnum :: StateType -> Int

enumFrom :: StateType -> [StateType]

enumFromThen :: StateType -> StateType -> [StateType]

enumFromTo :: StateType -> StateType -> [StateType]

enumFromThenTo :: StateType -> StateType -> StateType -> [StateType]

Eq StateType

Defined in GI.Atk.Enums

Methods

(==) :: StateType -> StateType -> Bool

(/=) :: StateType -> StateType -> Bool

Ord StateType

Defined in GI.Atk.Enums

Methods

compare :: StateType -> StateType -> Ordering

(<) :: StateType -> StateType -> Bool

(<=) :: StateType -> StateType -> Bool

(>) :: StateType -> StateType -> Bool

(>=) :: StateType -> StateType -> Bool

max :: StateType -> StateType -> StateType

min :: StateType -> StateType -> StateType

Show StateType

Defined in GI.Atk.Enums

Methods

showsPrec :: Int -> StateType -> ShowS

show :: StateType -> String

showList :: [StateType] -> ShowS

TypedObject StateType

Defined in GI.Atk.Enums

Methods

glibType :: IO GType

BoxedEnum StateType

Defined in GI.Atk.Enums

HasParentTypes StateType

Defined in GI.Atk.Enums

type ParentTypes StateType

Defined in GI.Atk.Enums

type ParentTypes StateType = '[] :: [Type]

TextAttribute

data TextAttribute

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

Enum TextAttribute

Defined in GI.Atk.Enums

Methods

succ :: TextAttribute -> TextAttribute

pred :: TextAttribute -> TextAttribute

toEnum :: Int -> TextAttribute

fromEnum :: TextAttribute -> Int

enumFrom :: TextAttribute -> [TextAttribute]

enumFromThen :: TextAttribute -> TextAttribute -> [TextAttribute]

enumFromTo :: TextAttribute -> TextAttribute -> [TextAttribute]

enumFromThenTo :: TextAttribute -> TextAttribute -> TextAttribute -> [TextAttribute]

Eq TextAttribute

Defined in GI.Atk.Enums

Methods

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

(/=) :: TextAttribute -> TextAttribute -> Bool

Ord TextAttribute

Defined in GI.Atk.Enums

Methods

compare :: TextAttribute -> TextAttribute -> Ordering

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

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

(>) :: TextAttribute -> TextAttribute -> Bool

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

max :: TextAttribute -> TextAttribute -> TextAttribute

min :: TextAttribute -> TextAttribute -> TextAttribute

Show TextAttribute

Defined in GI.Atk.Enums

Methods

showsPrec :: Int -> TextAttribute -> ShowS

show :: TextAttribute -> String

showList :: [TextAttribute] -> ShowS

TypedObject TextAttribute

Defined in GI.Atk.Enums

Methods

glibType :: IO GType

BoxedEnum TextAttribute

Defined in GI.Atk.Enums

HasParentTypes TextAttribute

Defined in GI.Atk.Enums

type ParentTypes TextAttribute

Defined in GI.Atk.Enums

type ParentTypes TextAttribute = '[] :: [Type]

TextBoundary

data TextBoundary

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

Enum TextBoundary

Defined in GI.Atk.Enums

Methods

succ :: TextBoundary -> TextBoundary

pred :: TextBoundary -> TextBoundary

toEnum :: Int -> TextBoundary

fromEnum :: TextBoundary -> Int

enumFrom :: TextBoundary -> [TextBoundary]

enumFromThen :: TextBoundary -> TextBoundary -> [TextBoundary]

enumFromTo :: TextBoundary -> TextBoundary -> [TextBoundary]

enumFromThenTo :: TextBoundary -> TextBoundary -> TextBoundary -> [TextBoundary]

Eq TextBoundary

Defined in GI.Atk.Enums

Methods

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

(/=) :: TextBoundary -> TextBoundary -> Bool

Ord TextBoundary

Defined in GI.Atk.Enums

Methods

compare :: TextBoundary -> TextBoundary -> Ordering

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

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

(>) :: TextBoundary -> TextBoundary -> Bool

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

max :: TextBoundary -> TextBoundary -> TextBoundary

min :: TextBoundary -> TextBoundary -> TextBoundary

Show TextBoundary

Defined in GI.Atk.Enums

Methods

showsPrec :: Int -> TextBoundary -> ShowS

show :: TextBoundary -> String

showList :: [TextBoundary] -> ShowS

TypedObject TextBoundary

Defined in GI.Atk.Enums

Methods

glibType :: IO GType

BoxedEnum TextBoundary

Defined in GI.Atk.Enums

HasParentTypes TextBoundary

Defined in GI.Atk.Enums

type ParentTypes TextBoundary

Defined in GI.Atk.Enums

type ParentTypes TextBoundary = '[] :: [Type]

TextClipType

data TextClipType

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

Enum TextClipType

Defined in GI.Atk.Enums

Methods

succ :: TextClipType -> TextClipType

pred :: TextClipType -> TextClipType

toEnum :: Int -> TextClipType

fromEnum :: TextClipType -> Int

enumFrom :: TextClipType -> [TextClipType]

enumFromThen :: TextClipType -> TextClipType -> [TextClipType]

enumFromTo :: TextClipType -> TextClipType -> [TextClipType]

enumFromThenTo :: TextClipType -> TextClipType -> TextClipType -> [TextClipType]

Eq TextClipType

Defined in GI.Atk.Enums

Methods

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

(/=) :: TextClipType -> TextClipType -> Bool

Ord TextClipType

Defined in GI.Atk.Enums

Methods

compare :: TextClipType -> TextClipType -> Ordering

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

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

(>) :: TextClipType -> TextClipType -> Bool

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

max :: TextClipType -> TextClipType -> TextClipType

min :: TextClipType -> TextClipType -> TextClipType

Show TextClipType

Defined in GI.Atk.Enums

Methods

showsPrec :: Int -> TextClipType -> ShowS

show :: TextClipType -> String

showList :: [TextClipType] -> ShowS

TypedObject TextClipType

Defined in GI.Atk.Enums

Methods

glibType :: IO GType

BoxedEnum TextClipType

Defined in GI.Atk.Enums

HasParentTypes TextClipType

Defined in GI.Atk.Enums

type ParentTypes TextClipType

Defined in GI.Atk.Enums

type ParentTypes TextClipType = '[] :: [Type]

TextGranularity

data TextGranularity

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

Enum TextGranularity

Defined in GI.Atk.Enums

Methods

succ :: TextGranularity -> TextGranularity

pred :: TextGranularity -> TextGranularity

toEnum :: Int -> TextGranularity

fromEnum :: TextGranularity -> Int

enumFrom :: TextGranularity -> [TextGranularity]

enumFromThen :: TextGranularity -> TextGranularity -> [TextGranularity]

enumFromTo :: TextGranularity -> TextGranularity -> [TextGranularity]

enumFromThenTo :: TextGranularity -> TextGranularity -> TextGranularity -> [TextGranularity]

Eq TextGranularity

Defined in GI.Atk.Enums

Methods

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

(/=) :: TextGranularity -> TextGranularity -> Bool

Ord TextGranularity

Defined in GI.Atk.Enums

Methods

compare :: TextGranularity -> TextGranularity -> Ordering

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

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

(>) :: TextGranularity -> TextGranularity -> Bool

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

max :: TextGranularity -> TextGranularity -> TextGranularity

min :: TextGranularity -> TextGranularity -> TextGranularity

Show TextGranularity

Defined in GI.Atk.Enums

Methods

showsPrec :: Int -> TextGranularity -> ShowS

show :: TextGranularity -> String

showList :: [TextGranularity] -> ShowS

TypedObject TextGranularity

Defined in GI.Atk.Enums

Methods

glibType :: IO GType

BoxedEnum TextGranularity

Defined in GI.Atk.Enums

HasParentTypes TextGranularity

Defined in GI.Atk.Enums

type ParentTypes TextGranularity

Defined in GI.Atk.Enums

type ParentTypes TextGranularity = '[] :: [Type]

ValueType

data ValueType

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

Enum ValueType

Defined in GI.Atk.Enums

Methods

succ :: ValueType -> ValueType

pred :: ValueType -> ValueType

toEnum :: Int -> ValueType

fromEnum :: ValueType -> Int

enumFrom :: ValueType -> [ValueType]

enumFromThen :: ValueType -> ValueType -> [ValueType]

enumFromTo :: ValueType -> ValueType -> [ValueType]

enumFromThenTo :: ValueType -> ValueType -> ValueType -> [ValueType]

Eq ValueType

Defined in GI.Atk.Enums

Methods

(==) :: ValueType -> ValueType -> Bool

(/=) :: ValueType -> ValueType -> Bool

Ord ValueType

Defined in GI.Atk.Enums

Methods

compare :: ValueType -> ValueType -> Ordering

(<) :: ValueType -> ValueType -> Bool

(<=) :: ValueType -> ValueType -> Bool

(>) :: ValueType -> ValueType -> Bool

(>=) :: ValueType -> ValueType -> Bool

max :: ValueType -> ValueType -> ValueType

min :: ValueType -> ValueType -> ValueType

Show ValueType

Defined in GI.Atk.Enums

Methods

showsPrec :: Int -> ValueType -> ShowS

show :: ValueType -> String

showList :: [ValueType] -> ShowS

TypedObject ValueType

Defined in GI.Atk.Enums

Methods

glibType :: IO GType

BoxedEnum ValueType

Defined in GI.Atk.Enums

HasParentTypes ValueType

Defined in GI.Atk.Enums

type ParentTypes ValueType

Defined in GI.Atk.Enums

type ParentTypes ValueType = '[] :: [Type]