gecko-dev/accessible/html/HTMLSelectAccessible.h

231 lines
6.6 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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_HTMLSelectAccessible_h__
#define mozilla_a11y_HTMLSelectAccessible_h__
#include "HTMLFormControlAccessible.h"
class nsIMutableArray;
namespace mozilla {
namespace a11y {
/**
* Selects, Listboxes and Comboboxes, are made up of a number of different
* widgets, some of which are shared between the two. This file contains
* all of the widgets for both of the Selects, for HTML only.
*
* Listbox:
* - HTMLSelectListAccessible
* - HTMLSelectOptionAccessible
*
* Comboboxes:
* - HTMLComboboxAccessible
* - HTMLComboboxListAccessible [ inserted in accessible tree ]
* - HTMLSelectOptionAccessible(s)
*/
/*
* The list that contains all the options in the select.
*/
class HTMLSelectListAccessible : public AccessibleWrap
{
public:
HTMLSelectListAccessible(nsIContent* aContent, DocAccessible* aDoc);
virtual ~HTMLSelectListAccessible() {}
// Accessible
virtual a11y::role NativeRole() MOZ_OVERRIDE;
virtual uint64_t NativeState() MOZ_OVERRIDE;
// SelectAccessible
virtual bool SelectAll() MOZ_OVERRIDE;
virtual bool UnselectAll() MOZ_OVERRIDE;
// Widgets
virtual bool IsWidget() const MOZ_OVERRIDE;
virtual bool IsActiveWidget() const MOZ_OVERRIDE;
virtual bool AreItemsOperable() const MOZ_OVERRIDE;
virtual Accessible* CurrentItem() MOZ_OVERRIDE;
virtual void SetCurrentItem(Accessible* aItem) MOZ_OVERRIDE;
protected:
// Accessible
virtual void CacheChildren() MOZ_OVERRIDE;
};
/*
* Options inside the select, contained within the list
*/
class HTMLSelectOptionAccessible : public HyperTextAccessibleWrap
{
public:
enum { eAction_Select = 0 };
HTMLSelectOptionAccessible(nsIContent* aContent, DocAccessible* aDoc);
virtual ~HTMLSelectOptionAccessible() {}
// Accessible
virtual a11y::role NativeRole() MOZ_OVERRIDE;
virtual uint64_t NativeState() MOZ_OVERRIDE;
virtual uint64_t NativeInteractiveState() const MOZ_OVERRIDE;
virtual int32_t GetLevelInternal() MOZ_OVERRIDE;
virtual nsRect RelativeBounds(nsIFrame** aBoundingFrame) const MOZ_OVERRIDE;
virtual void SetSelected(bool aSelect) MOZ_OVERRIDE;
// ActionAccessible
virtual uint8_t ActionCount() MOZ_OVERRIDE;
virtual void ActionNameAt(uint8_t aIndex, nsAString& aName) MOZ_OVERRIDE;
virtual bool DoAction(uint8_t aIndex) MOZ_OVERRIDE;
// Widgets
virtual Accessible* ContainerWidget() const MOZ_OVERRIDE;
protected:
// Accessible
virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;
private:
/**
* Return a select accessible the option belongs to if any.
*/
Accessible* GetSelect() const
{
Accessible* parent = mParent;
if (parent && parent->IsHTMLOptGroup())
parent = parent->Parent();
if (parent && parent->IsListControl()) {
Accessible* combobox = parent->Parent();
return combobox && combobox->IsCombobox() ? combobox : mParent.get();
}
return nullptr;
}
/**
* Return a combobox accessible the option belongs to if any.
*/
Accessible* GetCombobox() const
{
Accessible* parent = mParent;
if (parent && parent->IsHTMLOptGroup())
parent = parent->Parent();
if (parent && parent->IsListControl()) {
Accessible* combobox = parent->Parent();
return combobox && combobox->IsCombobox() ? combobox : nullptr;
}
return nullptr;
}
};
/*
* Opt Groups inside the select, contained within the list
*/
class HTMLSelectOptGroupAccessible : public HTMLSelectOptionAccessible
{
public:
HTMLSelectOptGroupAccessible(nsIContent* aContent, DocAccessible* aDoc) :
HTMLSelectOptionAccessible(aContent, aDoc)
{ mType = eHTMLOptGroupType; }
virtual ~HTMLSelectOptGroupAccessible() {}
// Accessible
virtual a11y::role NativeRole() MOZ_OVERRIDE;
virtual uint64_t NativeInteractiveState() const MOZ_OVERRIDE;
// ActionAccessible
virtual uint8_t ActionCount() MOZ_OVERRIDE;
virtual void ActionNameAt(uint8_t aIndex, nsAString& aName) MOZ_OVERRIDE;
virtual bool DoAction(uint8_t aIndex) MOZ_OVERRIDE;
};
/** ------------------------------------------------------ */
/** Finally, the Combobox widgets */
/** ------------------------------------------------------ */
class HTMLComboboxListAccessible;
/*
* A class the represents the HTML Combobox widget.
*/
class HTMLComboboxAccessible MOZ_FINAL : public AccessibleWrap
{
public:
enum { eAction_Click = 0 };
HTMLComboboxAccessible(nsIContent* aContent, DocAccessible* aDoc);
virtual ~HTMLComboboxAccessible() {}
// Accessible
virtual void Shutdown() MOZ_OVERRIDE;
virtual void Description(nsString& aDescription) MOZ_OVERRIDE;
virtual void Value(nsString& aValue) MOZ_OVERRIDE;
virtual a11y::role NativeRole() MOZ_OVERRIDE;
virtual uint64_t NativeState() MOZ_OVERRIDE;
virtual void InvalidateChildren() MOZ_OVERRIDE;
// ActionAccessible
virtual uint8_t ActionCount() MOZ_OVERRIDE;
virtual void ActionNameAt(uint8_t aIndex, nsAString& aName) MOZ_OVERRIDE;
virtual bool DoAction(uint8_t aIndex) MOZ_OVERRIDE;
// Widgets
virtual bool IsWidget() const MOZ_OVERRIDE;
virtual bool IsActiveWidget() const MOZ_OVERRIDE;
virtual bool AreItemsOperable() const MOZ_OVERRIDE;
virtual Accessible* CurrentItem() MOZ_OVERRIDE;
virtual void SetCurrentItem(Accessible* aItem) MOZ_OVERRIDE;
protected:
// Accessible
virtual void CacheChildren() MOZ_OVERRIDE;
/**
* Return selected option.
*/
Accessible* SelectedOption() const;
private:
nsRefPtr<HTMLComboboxListAccessible> mListAccessible;
};
/*
* A class that represents the window that lives to the right
* of the drop down button inside the Select. This is the window
* that is made visible when the button is pressed.
*/
class HTMLComboboxListAccessible : public HTMLSelectListAccessible
{
public:
HTMLComboboxListAccessible(Accessible* aParent, nsIContent* aContent,
DocAccessible* aDoc);
virtual ~HTMLComboboxListAccessible() {}
// Accessible
virtual nsIFrame* GetFrame() const MOZ_OVERRIDE;
virtual a11y::role NativeRole() MOZ_OVERRIDE;
virtual uint64_t NativeState() MOZ_OVERRIDE;
virtual nsRect RelativeBounds(nsIFrame** aBoundingFrame) const MOZ_OVERRIDE;
// Widgets
virtual bool IsActiveWidget() const MOZ_OVERRIDE;
virtual bool AreItemsOperable() const MOZ_OVERRIDE;
};
} // namespace a11y
} // namespace mozilla
#endif