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