third_party/blink/renderer/modules/accessibility/ax_menu_list_popup.h

/*
 * Copyright (C) 2010 Apple Inc. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef THIRD_PARTY_BLINK_RENDERER_MODULES_ACCESSIBILITY_AX_MENU_LIST_POPUP_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_ACCESSIBILITY_AX_MENU_LIST_POPUP_H_

#include "third_party/blink/renderer/modules/accessibility/ax_mock_object.h"

namespace blink {

class AXObjectCacheImpl;
class AXMenuListOption;
class HTMLElement;

// AXMenuListPopup is the only kind of AXMockObject used in Blink accessibility.
class AXMenuListPopup final : public AXMockObject {
 public:
  explicit AXMenuListPopup(AXObjectCacheImpl&);

  AXMenuListPopup(const AXMenuListPopup&) = delete;
  AXMenuListPopup& operator=(const AXMenuListPopup&) = delete;

  void Trace(Visitor*) const override;

  void Init(AXObject* parent) override;
  void Detach() override;

  AXRestriction Restriction() const override;
  bool IsOffScreen() const override;

  void DidUpdateActiveOption(int option_index, bool fire_notifications = true);
  void DidShow();
  void DidHide();
  AXObject* ActiveDescendant() final;
  AXObject* owner() const { return owner_; }

 private:
  bool IsMenuListPopup() const override { return true; }

  ax::mojom::blink::Role NativeRoleIgnoringAria() const override;

  bool IsVisible() const override;
  bool OnNativeClickAction() override;
  void AddChildren() override;
  bool ComputeAccessibilityIsIgnored(IgnoredReasons* = nullptr) const override;

  AXMenuListOption* MenuListOptionAXObject(HTMLElement*);
  int GetSelectedIndex() const;

  // Note that this may be -1 if nothing is selected.
  int active_index_;

  Member<AXObject> owner_;
};

template <>
struct DowncastTraits<AXMenuListPopup> {
  static bool AllowFrom(const AXObject& object) {
    return object.IsMenuListPopup();
  }
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_MODULES_ACCESSIBILITY_AX_MENU_LIST_POPUP_H_