Type Aliases

The following type aliases are available globally.

  • This is a singly-linked list (a GSList) of AtkAttribute. It is used by atk_text_get_run_attributes(), atk_text_get_default_attributes(), atk_editable_text_set_run_attributes(), atk_document_get_attributes() and atk_object_get_attributes()

    Declaration

    Swift

    public typealias AttributeSet = AtkAttributeSet
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public typealias State = AtkState
    Show on GitHub

  • A function which is called when an object emits a matching event, as used in atk_add_focus_tracker. Currently the only events for which object-specific handlers are supported are events of type “focus:”. Most clients of ATK will prefer to attach signal handlers for the various ATK signals instead.

    see atk_add_focus_tracker.

    Declaration

    Swift

    public typealias EventListener = AtkEventListener
    Show on GitHub

  • An AtkEventListenerInit function is a special function that is called in order to initialize the per-object event registration system used by AtkEventListener, if any preparation is required.

    see atk_focus_tracker_init.

    Declaration

    Swift

    public typealias EventListenerInit = AtkEventListenerInit
    Show on GitHub

  • The type of callback function used for atk_component_add_focus_handler() and atk_component_remove_focus_handler()

    FocusHandler is deprecated: Deprecated with atk_component_add_focus_handler() and atk_component_remove_focus_handler(). See those methods for more information.

    Declaration

    Swift

    public typealias FocusHandler = AtkFocusHandler
    Show on GitHub

  • An AtkFunction is a function definition used for padding which has been added to class and interface structures to allow for expansion in the future.

    Declaration

    Swift

    public typealias Function = AtkFunction
    Show on GitHub

  • An AtkKeySnoopFunc is a type of callback which is called whenever a key event occurs, if registered via atk_add_key_event_listener. It allows for pre-emptive interception of key events via the return code as described below.

    Declaration

    Swift

    public typealias KeySnoopFunc = AtkKeySnoopFunc
    Show on GitHub

  • An AtkPropertyChangeHandler is a function which is executed when an AtkObject’s property changes value. It is specified in a call to atk_object_connect_property_change_handler().

    PropertyChangeHandler is deprecated: Since 2.12.

    Declaration

    Swift

    public typealias PropertyChangeHandler = AtkPropertyChangeHandler
    Show on GitHub

  • Specifies how xy coordinates are to be interpreted. Used by functions such as atk_component_get_position() and atk_text_get_character_extents()

    Declaration

    Swift

    public typealias CoordType = AtkCoordType
    Show on GitHub

  • Specifies the type of a keyboard evemt.

    Declaration

    Swift

    public typealias KeyEventType = AtkKeyEventType
    Show on GitHub

  • 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.

    Declaration

    Swift

    public typealias Layer = AtkLayer
    Show on GitHub

  • Describes the type of the relation

    Declaration

    Swift

    public typealias RelationType = AtkRelationType
    Show on GitHub

  • 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 >= ATK_ROLE_LAST_DEFINED is not necessarily an error.

    Declaration

    Swift

    public typealias Role = AtkRole
    Show on GitHub

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

    Declaration

    Swift

    public typealias ScrollType = AtkScrollType
    Show on GitHub

  • The possible types of states of an object

    Declaration

    Swift

    public typealias StateType = AtkStateType
    Show on GitHub

  • Describes the text attributes supported

    Declaration

    Swift

    public typealias TextAttribute = AtkTextAttribute
    Show on GitHub

  • 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.

    Declaration

    Swift

    public typealias TextBoundary = AtkTextBoundary
    Show on GitHub

  • Describes the type of clipping required.

    Declaration

    Swift

    public typealias TextClipType = AtkTextClipType
    Show on GitHub

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

    Declaration

    Swift

    public typealias TextGranularity = AtkTextGranularity
    Show on GitHub

  • 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 atk_value_type_get_localized_name().

    Declaration

    Swift

    public typealias ValueType = AtkValueType
    Show on GitHub