mirror of
https://github.com/mozilla/gecko-dev.git
synced 2025-11-02 01:09:04 +02:00
b32ecd1bf9
This revision is a step towards ensuring we get the right domains for known accessibility instantiators. We want to anticipate the needs of known clients and make sure we have all the cache domains ready, especially for heavy-use clients like screen readers. The domains we'll need are a bit of a work in progress, but can be updated easily. For now, err on the side of caution. This revision also implements better client detection on macOS, so we can handle multiple clients. Differential Revision: https://phabricator.services.mozilla.com/D220035
142 lines
4.4 KiB
C++
142 lines
4.4 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=2 et sw=2 tw=80: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef mozilla_a11y_Platform_h
|
|
#define mozilla_a11y_Platform_h
|
|
|
|
#include <stdint.h>
|
|
#include "nsStringFwd.h"
|
|
#include "Units.h"
|
|
|
|
#if defined(ANDROID)
|
|
# include "nsTArray.h"
|
|
# include "nsRect.h"
|
|
#endif
|
|
|
|
#ifdef MOZ_WIDGET_COCOA
|
|
# include "mozilla/a11y/Role.h"
|
|
# include "nsTArray.h"
|
|
#endif
|
|
|
|
namespace mozilla {
|
|
namespace a11y {
|
|
|
|
class Accessible;
|
|
class RemoteAccessible;
|
|
|
|
enum EPlatformDisabledState {
|
|
ePlatformIsForceEnabled = -1,
|
|
ePlatformIsEnabled = 0,
|
|
ePlatformIsDisabled = 1
|
|
};
|
|
|
|
/**
|
|
* Return the platform disabled state.
|
|
*/
|
|
EPlatformDisabledState PlatformDisabledState();
|
|
|
|
#ifdef MOZ_ACCESSIBILITY_ATK
|
|
/**
|
|
* Perform initialization that should be done as soon as possible, in order
|
|
* to minimize startup time.
|
|
* XXX: this function and the next defined in ApplicationAccessibleWrap.cpp
|
|
*/
|
|
void PreInit();
|
|
#endif
|
|
|
|
#if defined(MOZ_ACCESSIBILITY_ATK) || defined(XP_DARWIN)
|
|
/**
|
|
* Is platform accessibility enabled.
|
|
* Only used on Linux, MacOS and iOS for now.
|
|
*/
|
|
bool ShouldA11yBeEnabled();
|
|
#endif
|
|
|
|
#if defined(XP_WIN)
|
|
/*
|
|
* Name of platform service that instantiated accessibility
|
|
*/
|
|
void SetInstantiator(const uint32_t aInstantiatorPid);
|
|
bool GetInstantiator(nsIFile** aOutInstantiator);
|
|
#endif
|
|
|
|
/**
|
|
* Called to initialize platform specific accessibility support.
|
|
* Note this is called after internal accessibility support is initialized.
|
|
*/
|
|
void PlatformInit();
|
|
|
|
/**
|
|
* Shutdown platform accessibility.
|
|
* Note this is called before internal accessibility support is shutdown.
|
|
*/
|
|
void PlatformShutdown();
|
|
|
|
/**
|
|
* called when a new RemoteAccessible is created, so the platform may setup a
|
|
* wrapper for it, or take other action.
|
|
*/
|
|
void ProxyCreated(RemoteAccessible* aProxy);
|
|
|
|
/**
|
|
* Called just before a RemoteAccessible is destroyed so its wrapper can be
|
|
* disposed of and other action taken.
|
|
*/
|
|
void ProxyDestroyed(RemoteAccessible*);
|
|
|
|
/**
|
|
* Called when an event is fired on an Accessible so that platforms may fire
|
|
* events if appropriate.
|
|
*/
|
|
void PlatformEvent(Accessible* aTarget, uint32_t aEventType);
|
|
void PlatformStateChangeEvent(Accessible* aTarget, uint64_t aState,
|
|
bool aEnabled);
|
|
|
|
void PlatformFocusEvent(Accessible* aTarget,
|
|
const LayoutDeviceIntRect& aCaretRect);
|
|
void PlatformCaretMoveEvent(Accessible* aTarget, int32_t aOffset,
|
|
bool aIsSelectionCollapsed, int32_t aGranularity,
|
|
const LayoutDeviceIntRect& aCaretRect,
|
|
bool aFromUser);
|
|
void PlatformTextChangeEvent(Accessible* aTarget, const nsAString& aStr,
|
|
int32_t aStart, uint32_t aLen, bool aIsInsert,
|
|
bool aFromUser);
|
|
void PlatformShowHideEvent(Accessible* aTarget, Accessible* aParent,
|
|
bool aInsert, bool aFromUser);
|
|
void PlatformSelectionEvent(Accessible* aTarget, Accessible* aWidget,
|
|
uint32_t aType);
|
|
|
|
#if defined(ANDROID)
|
|
void PlatformScrollingEvent(Accessible* aTarget, uint32_t aEventType,
|
|
uint32_t aScrollX, uint32_t aScrollY,
|
|
uint32_t aMaxScrollX, uint32_t aMaxScrollY);
|
|
|
|
void PlatformAnnouncementEvent(Accessible* aTarget,
|
|
const nsAString& aAnnouncement,
|
|
uint16_t aPriority);
|
|
|
|
bool LocalizeString(const nsAString& aToken, nsAString& aLocalized);
|
|
#endif
|
|
|
|
#ifdef MOZ_WIDGET_COCOA
|
|
class TextRange;
|
|
void PlatformTextSelectionChangeEvent(Accessible* aTarget,
|
|
const nsTArray<TextRange>& aSelection);
|
|
|
|
void PlatformRoleChangedEvent(Accessible* aTarget, const a11y::role& aRole,
|
|
uint8_t aRoleMapEntryIndex);
|
|
#endif
|
|
|
|
// Get the cache domains needed by any known clients interacting with Gecko. If
|
|
// any known clients are found, the return value is aCacheDomains bitwise OR'd
|
|
// with the required cache domains for those clients. Otherwise, the return
|
|
// value is aCacheDomains unaltered.
|
|
uint64_t GetCacheDomainsForKnownClients(uint64_t aCacheDomains);
|
|
|
|
} // namespace a11y
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_a11y_Platform_h
|