Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

AttributeSet: SList
State: number

Variables

BINARY_AGE: number

Like atk_get_binary_age(), but from the headers used at application compile time, rather than from the library linked against at application run time.

INTERFACE_AGE: number

Like atk_get_interface_age(), but from the headers used at application compile time, rather than from the library linked against at application run time.

MAJOR_VERSION: number

Like atk_get_major_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

MICRO_VERSION: number

Like atk_get_micro_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

MINOR_VERSION: number

Like atk_get_minor_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

VERSION_MIN_REQUIRED: number

A macro that should be defined by the user prior to including the atk/atk.h header. The definition should be one of the predefined ATK version macros: %ATK_VERSION_2_12, %ATK_VERSION_2_14,...

This macro defines the earliest version of ATK that the package is required to be able to compile against.

If the compiler is configured to warn about the use of deprecated functions, then using functions that were deprecated in version %ATK_VERSION_MIN_REQUIRED or earlier will cause warnings (but using functions deprecated in later releases will not).

Functions

  • attribute_set_free(attrib_set: SList): void
  • Frees the memory used by an #AtkAttributeSet, including all its #AtkAttributes.

    Parameters

    • attrib_set: SList

      The #AtkAttributeSet to free

    Returns void

  • focus_tracker_notify(object: Atk.Object): void
  • Cause the focus tracker functions which have been specified to be executed for the object.

    Parameters

    Returns void

  • get_binary_age(): number
  • Returns the binary age as passed to libtool when building the ATK library the process is running against.

    Returns number

  • Gets a default implementation of the #AtkObjectFactory/type registry. Note: For most toolkit maintainers, this will be the correct registry for registering new #AtkObject factories. Following a call to this function, maintainers may call atk_registry_set_factory_type() to associate an #AtkObjectFactory subclass with the GType of objects for whom accessibility information will be provided.

    Returns Atk.Registry

  • get_interface_age(): number
  • Returns the interface age as passed to libtool when building the ATK library the process is running against.

    Returns number

  • get_major_version(): number
  • Returns the major version number of the ATK library. (e.g. in ATK version 2.7.4 this is 2.)

    This function is in the library, so it represents the ATK library your code is running against. In contrast, the #ATK_MAJOR_VERSION macro represents the major version of the ATK headers you have included when compiling your code.

    Returns number

  • get_micro_version(): number
  • Returns the micro version number of the ATK library. (e.g. in ATK version 2.7.4 this is 4.)

    This function is in the library, so it represents the ATK library your code is are running against. In contrast, the #ATK_MICRO_VERSION macro represents the micro version of the ATK headers you have included when compiling your code.

    Returns number

  • get_minor_version(): number
  • Returns the minor version number of the ATK library. (e.g. in ATK version 2.7.4 this is 7.)

    This function is in the library, so it represents the ATK library your code is are running against. In contrast, the #ATK_MINOR_VERSION macro represents the minor version of the ATK headers you have included when compiling your code.

    Returns number

  • get_toolkit_name(): string
  • get_toolkit_version(): string
  • get_version(): string
  • Get the #AtkRelationType type corresponding to a relation name.

    Parameters

    • name: string

      a string which is the (non-localized) name of an ATK relation type.

    Returns Atk.RelationType

  • remove_focus_tracker(tracker_id: number): void
  • Removes the specified focus tracker from the list of functions to be called when any object receives focus.

    Parameters

    • tracker_id: number

      the id of the focus tracker to remove

    Returns void

  • remove_global_event_listener(listener_id: number): void
  • listener_id is the value returned by #atk_add_global_event_listener when you registered that event listener.

    Toolkit implementor note: ATK provides a default implementation for this virtual method. ATK implementors are discouraged from reimplementing this method.

    Toolkit implementor note: this method is not intended to be used by ATK implementors but by ATK consumers.

    Removes the specified event listener

    Parameters

    • listener_id: number

      the id of the event listener to remove

    Returns void

  • remove_key_event_listener(listener_id: number): void
  • listener_id is the value returned by #atk_add_key_event_listener when you registered that event listener.

    Removes the specified event listener.

    Parameters

    • listener_id: number

      the id of the event listener to remove

    Returns void

  • role_for_name(name: string): Atk.Role
  • Get the #AtkRole type corresponding to a rolew name.

    Parameters

    • name: string

      a string which is the (non-localized) name of an ATK role.

    Returns Atk.Role

  • role_get_localized_name(role: Atk.Role): string
  • Gets the localized description string describing the #AtkRole role.

    Parameters

    • role: Atk.Role

      The #AtkRole whose localized name is required

    Returns string

  • role_get_name(role: Atk.Role): string
  • role_register(name: string): Atk.Role
  • Registers the role specified by name. name must be a meaningful name. So it should not be empty, or consisting on whitespaces.

    Parameters

    • name: string

      a character string describing the new role.

    Returns Atk.Role

  • Get the #AtkTextAttribute type corresponding to a text attribute name.

    Parameters

    • name: string

      a string which is the (non-localized) name of an ATK text attribute.

    Returns TextAttribute

  • text_attribute_get_value(attr: TextAttribute, index_: number): string | null
  • Gets the value for the index of the #AtkTextAttribute

    Parameters

    • attr: TextAttribute

      The #AtkTextAttribute for which a value is required

    • index_: number

      The index of the required value

    Returns string | null

  • Frees the memory associated with an array of AtkTextRange. It is assumed that the array was returned by the function atk_text_get_bounded_ranges and is NULL terminated.

    Parameters

    • ranges: Atk.TextRange[]

      A pointer to an array of #AtkTextRange which is to be freed.

    Returns void

  • value_type_get_localized_name(value_type: Atk.ValueType): string
  • Gets the localized description string describing the #AtkValueType value_type.

    Parameters

    • value_type: Atk.ValueType

      The #AtkValueType whose localized name is required

    Returns string

  • Gets the description string describing the #AtkValueType value_type.

    Parameters

    • value_type: Atk.ValueType

      The #AtkValueType whose name is required

    Returns string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method