accessibility

package
v0.11.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 30, 2017 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Package accessibility implements the Accessibility domain.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewClient 

func NewClient(conn *rpcc.Conn) *domainClient

NewClient returns a client for the Accessibility domain with the connection set to conn.

Types

type AXGlobalStates 

type AXGlobalStates int

AXGlobalStates States which apply to every AX node. 

const (
	AXGlobalStatesNotSet AXGlobalStates = iota
	AXGlobalStatesBusy
	AXGlobalStatesDisabled
	AXGlobalStatesHidden
	AXGlobalStatesHiddenRoot
	AXGlobalStatesInvalid
	AXGlobalStatesKeyshortcuts
	AXGlobalStatesRoledescription
)

AXGlobalStates as enums.

func (AXGlobalStates) MarshalJSON 

func (e AXGlobalStates) MarshalJSON() ([]byte, error)

MarshalJSON encodes enum into a string or null when not set.

func (AXGlobalStates) String 

func (e AXGlobalStates) String() string

func (*AXGlobalStates) UnmarshalJSON 

func (e *AXGlobalStates) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes a string value into a enum.

func (AXGlobalStates) Valid 

func (e AXGlobalStates) Valid() bool

Valid returns true if enum is set.

type AXLiveRegionAttributes 

type AXLiveRegionAttributes int

AXLiveRegionAttributes Attributes which apply to nodes in live regions. 

const (
	AXLiveRegionAttributesNotSet AXLiveRegionAttributes = iota
	AXLiveRegionAttributesLive
	AXLiveRegionAttributesAtomic
	AXLiveRegionAttributesRelevant
	AXLiveRegionAttributesRoot
)

AXLiveRegionAttributes as enums.

func (AXLiveRegionAttributes) MarshalJSON 

func (e AXLiveRegionAttributes) MarshalJSON() ([]byte, error)

MarshalJSON encodes enum into a string or null when not set.

func (AXLiveRegionAttributes) String 

func (e AXLiveRegionAttributes) String() string

func (*AXLiveRegionAttributes) UnmarshalJSON 

func (e *AXLiveRegionAttributes) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes a string value into a enum.

func (AXLiveRegionAttributes) Valid 

func (e AXLiveRegionAttributes) Valid() bool

Valid returns true if enum is set.

type AXNode 

type AXNode struct {
	NodeID           AXNodeID           `json:"nodeId"`                     // Unique identifier for this node.
	Ignored          bool               `json:"ignored"`                    // Whether this node is ignored for accessibility
	IgnoredReasons   []AXProperty       `json:"ignoredReasons,omitempty"`   // Collection of reasons why this node is hidden.
	Role             *AXValue           `json:"role,omitempty"`             // This Node's role, whether explicit or implicit.
	Name             *AXValue           `json:"name,omitempty"`             // The accessible name for this Node.
	Description      *AXValue           `json:"description,omitempty"`      // The accessible description for this Node.
	Value            *AXValue           `json:"value,omitempty"`            // The value for this Node.
	Properties       []AXProperty       `json:"properties,omitempty"`       // All other properties
	ChildIDs         []AXNodeID         `json:"childIds,omitempty"`         // IDs for each of this node's child nodes.
	BackendDOMNodeID *dom.BackendNodeID `json:"backendDOMNodeId,omitempty"` // The backend ID for the associated DOM node, if any.
}

AXNode A node in the accessibility tree.

type AXNodeID 

type AXNodeID string

AXNodeID Unique accessibility node identifier.

type AXProperty 

type AXProperty struct {
	Name  string  `json:"name"`  // The name of this property.
	Value AXValue `json:"value"` // The value of this property.
}

AXProperty

type AXRelatedNode 

type AXRelatedNode struct {
	BackendDOMNodeID dom.BackendNodeID `json:"backendDOMNodeId"` // The BackendNodeId of the related DOM node.
	IDRef            *string           `json:"idref,omitempty"`  // The IDRef value provided, if any.
	Text             *string           `json:"text,omitempty"`   // The text alternative of this node in the current context.
}

AXRelatedNode

type AXRelationshipAttributes 

type AXRelationshipAttributes int

AXRelationshipAttributes Relationships between elements other than parent/child/sibling. 

const (
	AXRelationshipAttributesNotSet AXRelationshipAttributes = iota
	AXRelationshipAttributesActivedescendant
	AXRelationshipAttributesControls
	AXRelationshipAttributesDescribedby
	AXRelationshipAttributesDetails
	AXRelationshipAttributesErrormessage
	AXRelationshipAttributesFlowto
	AXRelationshipAttributesLabelledby
	AXRelationshipAttributesOwns
)

AXRelationshipAttributes as enums.

func (AXRelationshipAttributes) MarshalJSON 

func (e AXRelationshipAttributes) MarshalJSON() ([]byte, error)

MarshalJSON encodes enum into a string or null when not set.

func (AXRelationshipAttributes) String 

func (e AXRelationshipAttributes) String() string

func (*AXRelationshipAttributes) UnmarshalJSON 

func (e *AXRelationshipAttributes) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes a string value into a enum.

func (AXRelationshipAttributes) Valid 

func (e AXRelationshipAttributes) Valid() bool

Valid returns true if enum is set.

type AXValue 

type AXValue struct {
	Type         AXValueType     `json:"type"`                   // The type of this value.
	Value        json.RawMessage `json:"value,omitempty"`        // The computed value of this property.
	RelatedNodes []AXRelatedNode `json:"relatedNodes,omitempty"` // One or more related nodes, if applicable.
	Sources      []AXValueSource `json:"sources,omitempty"`      // The sources which contributed to the computation of this property.
}

AXValue A single computed AX property.

type AXValueNativeSourceType 

type AXValueNativeSourceType int

AXValueNativeSourceType Enum of possible native property sources (as a subtype of a particular AXValueSourceType). 

const (
	AXValueNativeSourceTypeNotSet AXValueNativeSourceType = iota
	AXValueNativeSourceTypeFigcaption
	AXValueNativeSourceTypeLabel
	AXValueNativeSourceTypeLabelfor
	AXValueNativeSourceTypeLabelwrapped
	AXValueNativeSourceTypeLegend
	AXValueNativeSourceTypeTablecaption
	AXValueNativeSourceTypeTitle
	AXValueNativeSourceTypeOther
)

AXValueNativeSourceType as enums.

func (AXValueNativeSourceType) MarshalJSON 

func (e AXValueNativeSourceType) MarshalJSON() ([]byte, error)

MarshalJSON encodes enum into a string or null when not set.

func (AXValueNativeSourceType) String 

func (e AXValueNativeSourceType) String() string

func (*AXValueNativeSourceType) UnmarshalJSON 

func (e *AXValueNativeSourceType) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes a string value into a enum.

func (AXValueNativeSourceType) Valid 

func (e AXValueNativeSourceType) Valid() bool

Valid returns true if enum is set.

type AXValueSource 

type AXValueSource struct {
	Type              AXValueSourceType       `json:"type"`                        // What type of source this is.
	Value             *AXValue                `json:"value,omitempty"`             // The value of this property source.
	Attribute         *string                 `json:"attribute,omitempty"`         // The name of the relevant attribute, if any.
	AttributeValue    *AXValue                `json:"attributeValue,omitempty"`    // The value of the relevant attribute, if any.
	Superseded        *bool                   `json:"superseded,omitempty"`        // Whether this source is superseded by a higher priority source.
	NativeSource      AXValueNativeSourceType `json:"nativeSource,omitempty"`      // The native markup source for this value, e.g. a <label> element.
	NativeSourceValue *AXValue                `json:"nativeSourceValue,omitempty"` // The value, such as a node or node list, of the native source.
	Invalid           *bool                   `json:"invalid,omitempty"`           // Whether the value for this property is invalid.
	InvalidReason     *string                 `json:"invalidReason,omitempty"`     // Reason for the value being invalid, if it is.
}

AXValueSource A single source for a computed AX property.

type AXValueSourceType 

type AXValueSourceType int

AXValueSourceType Enum of possible property sources. 

const (
	AXValueSourceTypeNotSet AXValueSourceType = iota
	AXValueSourceTypeAttribute
	AXValueSourceTypeImplicit
	AXValueSourceTypeStyle
	AXValueSourceTypeContents
	AXValueSourceTypePlaceholder
	AXValueSourceTypeRelatedElement
)

AXValueSourceType as enums.

func (AXValueSourceType) MarshalJSON 

func (e AXValueSourceType) MarshalJSON() ([]byte, error)

MarshalJSON encodes enum into a string or null when not set.

func (AXValueSourceType) String 

func (e AXValueSourceType) String() string

func (*AXValueSourceType) UnmarshalJSON 

func (e *AXValueSourceType) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes a string value into a enum.

func (AXValueSourceType) Valid 

func (e AXValueSourceType) Valid() bool

Valid returns true if enum is set.

type AXValueType 

type AXValueType int

AXValueType Enum of possible property types. 

const (
	AXValueTypeNotSet AXValueType = iota
	AXValueTypeBoolean
	AXValueTypeTristate
	AXValueTypeBooleanOrUndefined
	AXValueTypeIDRef
	AXValueTypeIdrefList
	AXValueTypeInteger
	AXValueTypeNode
	AXValueTypeNodeList
	AXValueTypeNumber
	AXValueTypeString
	AXValueTypeComputedString
	AXValueTypeToken
	AXValueTypeTokenList
	AXValueTypeDOMRelation
	AXValueTypeRole
	AXValueTypeInternalRole
	AXValueTypeValueUndefined
)

AXValueType as enums.

func (AXValueType) MarshalJSON 

func (e AXValueType) MarshalJSON() ([]byte, error)

MarshalJSON encodes enum into a string or null when not set.

func (AXValueType) String 

func (e AXValueType) String() string

func (*AXValueType) UnmarshalJSON 

func (e *AXValueType) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes a string value into a enum.

func (AXValueType) Valid 

func (e AXValueType) Valid() bool

Valid returns true if enum is set.

type AXWidgetAttributes 

type AXWidgetAttributes int

AXWidgetAttributes Attributes which apply to widgets. 

const (
	AXWidgetAttributesNotSet AXWidgetAttributes = iota
	AXWidgetAttributesAutocomplete
	AXWidgetAttributesHaspopup
	AXWidgetAttributesLevel
	AXWidgetAttributesMultiselectable
	AXWidgetAttributesOrientation
	AXWidgetAttributesMultiline
	AXWidgetAttributesReadonly
	AXWidgetAttributesRequired
	AXWidgetAttributesValuemin
	AXWidgetAttributesValuemax
	AXWidgetAttributesValuetext
)

AXWidgetAttributes as enums.

func (AXWidgetAttributes) MarshalJSON 

func (e AXWidgetAttributes) MarshalJSON() ([]byte, error)

MarshalJSON encodes enum into a string or null when not set.

func (AXWidgetAttributes) String 

func (e AXWidgetAttributes) String() string

func (*AXWidgetAttributes) UnmarshalJSON 

func (e *AXWidgetAttributes) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes a string value into a enum.

func (AXWidgetAttributes) Valid 

func (e AXWidgetAttributes) Valid() bool

Valid returns true if enum is set.

type AXWidgetStates 

type AXWidgetStates int

AXWidgetStates States which apply to widgets. 

const (
	AXWidgetStatesNotSet AXWidgetStates = iota
	AXWidgetStatesChecked
	AXWidgetStatesExpanded
	AXWidgetStatesModal
	AXWidgetStatesPressed
	AXWidgetStatesSelected
)

AXWidgetStates as enums.

func (AXWidgetStates) MarshalJSON 

func (e AXWidgetStates) MarshalJSON() ([]byte, error)

MarshalJSON encodes enum into a string or null when not set.

func (AXWidgetStates) String 

func (e AXWidgetStates) String() string

func (*AXWidgetStates) UnmarshalJSON 

func (e *AXWidgetStates) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes a string value into a enum.

func (AXWidgetStates) Valid 

func (e AXWidgetStates) Valid() bool

Valid returns true if enum is set.

type GetPartialAXTreeArgs 

type GetPartialAXTreeArgs struct {
	NodeID         dom.NodeID `json:"nodeId"`                   // ID of node to get the partial accessibility tree for.
	FetchRelatives *bool      `json:"fetchRelatives,omitempty"` // Whether to fetch this nodes ancestors, siblings and children. Defaults to true.
}

GetPartialAXTreeArgs represents the arguments for GetPartialAXTree in the Accessibility domain.

func NewGetPartialAXTreeArgs 

func NewGetPartialAXTreeArgs(nodeID dom.NodeID) *GetPartialAXTreeArgs

NewGetPartialAXTreeArgs initializes GetPartialAXTreeArgs with the required arguments.

func (*GetPartialAXTreeArgs) SetFetchRelatives 

func (a *GetPartialAXTreeArgs) SetFetchRelatives(fetchRelatives bool) *GetPartialAXTreeArgs

SetFetchRelatives sets the FetchRelatives optional argument. Whether to fetch this nodes ancestors, siblings and children. Defaults to true.

type GetPartialAXTreeReply 

type GetPartialAXTreeReply struct {
	Nodes []AXNode `json:"nodes"` // The Accessibility.AXNode for this DOM node, if it exists, plus its ancestors, siblings and children, if requested.
}

GetPartialAXTreeReply represents the return values for GetPartialAXTree in the Accessibility domain.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.