/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1998 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Original Author: Eric Vaughan (evaughan@netscape.com) * Kyle Yuan (kyle.yuan@sun.com) * * Alternatively, the contents of this file may be used under the terms of * either of the GNU General Public License Version 2 or later (the "GPL"), * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #include "nsXULSelectAccessible.h" #include "nsAccessibilityService.h" #include "nsArray.h" #include "nsIContent.h" #include "nsIDOMXULMenuListElement.h" #include "nsIDOMXULMultSelectCntrlEl.h" #include "nsIDOMXULSelectCntrlItemEl.h" #include "nsIDOMXULSelectCntrlEl.h" #include "nsIDOMXULTextboxElement.h" #include "nsIPresShell.h" #include "nsIServiceManager.h" /** * 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 XUL only. * (except nsXULRadioGroupAccessible which inherits * nsXULSelectableAccessible so that it supports nsIAccessibleSelectable) * * Listbox: * - nsXULListboxAccessible * - nsXULSelectListAccessible * - nsXULSelectOptionAccessible * * Comboboxes: * - nsXULComboboxAccessible * - nsHTMLTextFieldAccessible (editable) or nsTextAccessible (readonly) * - nsXULComboboxButtonAccessible * - nsXULSelectListAccessible * - nsXULSelectOptionAccessible */ /** ------------------------------------------------------ */ /** Impl. of nsXULSelectableAccessible */ /** ------------------------------------------------------ */ // Helper methos nsXULSelectableAccessible::nsXULSelectableAccessible(nsIDOMNode* aDOMNode, nsIWeakReference* aShell): nsAccessibleWrap(aDOMNode, aShell) { } NS_IMETHODIMP nsXULSelectableAccessible::GetName(nsAString& aName) { return GetXULName(aName, PR_FALSE); } NS_IMPL_ISUPPORTS_INHERITED1(nsXULSelectableAccessible, nsAccessible, nsIAccessibleSelectable) NS_IMETHODIMP nsXULSelectableAccessible::ChangeSelection(PRInt32 aIndex, PRUint8 aMethod, PRBool *aSelState) { nsCOMPtr childAcc; GetChildAt(aIndex, getter_AddRefs(childAcc)); nsCOMPtr accNode = do_QueryInterface(childAcc); NS_ENSURE_TRUE(accNode, NS_ERROR_FAILURE); nsCOMPtr childNode; accNode->GetDOMNode(getter_AddRefs(childNode)); nsCOMPtr item(do_QueryInterface(childNode)); NS_ENSURE_TRUE(item, NS_ERROR_FAILURE); *aSelState = PR_FALSE; nsCOMPtr xulSelect(do_QueryInterface(mDOMNode)); nsCOMPtr xulMultiSelect(do_QueryInterface(mDOMNode)); if (xulSelect || xulMultiSelect) { item->GetSelected(aSelState); if (eSelection_Add == aMethod && !(*aSelState)) { if (xulMultiSelect) return xulMultiSelect->AddItemToSelection(item); else if (xulSelect) return xulSelect->SetSelectedItem(item); } else if (eSelection_Remove == aMethod && (*aSelState)) { if (xulMultiSelect) return xulMultiSelect->RemoveItemFromSelection(item); else if (xulSelect) return xulSelect->SetSelectedIndex(-1); } } return NS_ERROR_FAILURE; } // Interface methods NS_IMETHODIMP nsXULSelectableAccessible::GetSelectedChildren(nsIArray **_retval) { *_retval = nsnull; nsCOMPtr accService(do_GetService("@mozilla.org/accessibilityService;1")); if (!accService) return NS_ERROR_FAILURE; nsCOMPtr selectedAccessibles; NS_NewArray(getter_AddRefs(selectedAccessibles)); if (!selectedAccessibles) return NS_ERROR_OUT_OF_MEMORY; // For XUL multi-select control nsCOMPtr xulMultiSelect(do_QueryInterface(mDOMNode)); if (xulMultiSelect) { PRInt32 length = 0; xulMultiSelect->GetSelectedCount(&length); for (PRInt32 index = 0; index < length; index++) { nsCOMPtr tempAccessible; nsCOMPtr tempNode; xulMultiSelect->GetSelectedItem(index, getter_AddRefs(tempNode)); nsCOMPtr tempDOMNode (do_QueryInterface(tempNode)); accService->GetAccessibleInWeakShell(tempDOMNode, mWeakShell, getter_AddRefs(tempAccessible)); if (tempAccessible) selectedAccessibles->AppendElement(tempAccessible, PR_FALSE); } } PRUint32 uLength = 0; selectedAccessibles->GetLength(&uLength); if (uLength != 0) { // length of nsIArray containing selected options *_retval = selectedAccessibles; NS_ADDREF(*_retval); } return NS_OK; } // return the nth selected child's nsIAccessible object NS_IMETHODIMP nsXULSelectableAccessible::RefSelection(PRInt32 aIndex, nsIAccessible **_retval) { *_retval = nsnull; nsCOMPtr accService(do_GetService("@mozilla.org/accessibilityService;1")); if (!accService) return NS_ERROR_FAILURE; nsCOMPtr tempDOMNode; nsCOMPtr xulMultiSelect(do_QueryInterface(mDOMNode)); if (xulMultiSelect) xulMultiSelect->GetSelectedItem(aIndex, getter_AddRefs(tempDOMNode)); nsCOMPtr xulSelect(do_QueryInterface(mDOMNode)); if (xulSelect && aIndex == 0) xulSelect->GetSelectedItem(getter_AddRefs(tempDOMNode)); if (tempDOMNode) { nsCOMPtr tempAccess; accService->GetAccessibleInWeakShell(tempDOMNode, mWeakShell, getter_AddRefs(tempAccess)); *_retval = tempAccess; NS_ADDREF(*_retval); return NS_OK; } return NS_ERROR_FAILURE; } NS_IMETHODIMP nsXULSelectableAccessible::GetSelectionCount(PRInt32 *aSelectionCount) { *aSelectionCount = 0; // For XUL multi-select control nsCOMPtr xulMultiSelect(do_QueryInterface(mDOMNode)); if (xulMultiSelect) return xulMultiSelect->GetSelectedCount(aSelectionCount); // For XUL single-select control/menulist nsCOMPtr xulSelect(do_QueryInterface(mDOMNode)); if (xulSelect) { PRInt32 index; xulSelect->GetSelectedIndex(&index); if (index >= 0) *aSelectionCount = 1; return NS_OK; } return NS_ERROR_FAILURE; } NS_IMETHODIMP nsXULSelectableAccessible::AddChildToSelection(PRInt32 aIndex) { PRBool isSelected; return ChangeSelection(aIndex, eSelection_Add, &isSelected); } NS_IMETHODIMP nsXULSelectableAccessible::RemoveChildFromSelection(PRInt32 aIndex) { PRBool isSelected; return ChangeSelection(aIndex, eSelection_Remove, &isSelected); } NS_IMETHODIMP nsXULSelectableAccessible::IsChildSelected(PRInt32 aIndex, PRBool *_retval) { *_retval = PR_FALSE; return ChangeSelection(aIndex, eSelection_GetState, _retval); } NS_IMETHODIMP nsXULSelectableAccessible::ClearSelection() { nsCOMPtr xulMultiSelect(do_QueryInterface(mDOMNode)); if (xulMultiSelect) return xulMultiSelect->ClearSelection(); nsCOMPtr xulSelect(do_QueryInterface(mDOMNode)); if (xulSelect) return xulSelect->SetSelectedIndex(-1); return NS_ERROR_FAILURE; } NS_IMETHODIMP nsXULSelectableAccessible::SelectAllSelection(PRBool *_retval) { *_retval = PR_TRUE; nsCOMPtr xulMultiSelect(do_QueryInterface(mDOMNode)); if (xulMultiSelect) return xulMultiSelect->SelectAll(); // otherwise, don't support this method *_retval = PR_FALSE; return NS_OK; } /** ------------------------------------------------------ */ /** First, the common widgets */ /** ------------------------------------------------------ */ /** ----- nsXULSelectListAccessible ----- */ /** Default Constructor */ nsXULSelectListAccessible::nsXULSelectListAccessible(nsIDOMNode* aDOMNode, nsIWeakReference* aShell) :nsAccessibleWrap(aDOMNode, aShell) { } NS_IMETHODIMP nsXULSelectListAccessible::GetRole(PRUint32 *_retval) { *_retval = ROLE_LIST; return NS_OK; } /** * As a nsXULSelectListAccessible we can have the following states: * STATE_MULTISELECTABLE * STATE_EXTSELECTABLE */ NS_IMETHODIMP nsXULSelectListAccessible::GetState(PRUint32 *_retval) { *_retval = 0; nsAutoString selectionTypeString; nsCOMPtr element(do_QueryInterface(mDOMNode)); NS_ASSERTION(element, "No nsIDOMElement for caption node!"); element->GetAttribute(NS_LITERAL_STRING("seltype"), selectionTypeString) ; if (selectionTypeString.LowerCaseEqualsLiteral("multiple")) *_retval |= STATE_MULTISELECTABLE | STATE_EXTSELECTABLE; return NS_OK; } /** ----- nsXULSelectOptionAccessible ----- */ /** Default Constructor */ nsXULSelectOptionAccessible::nsXULSelectOptionAccessible(nsIDOMNode* aDOMNode, nsIWeakReference* aShell): nsXULMenuitemAccessible(aDOMNode, aShell) { } NS_IMETHODIMP nsXULSelectOptionAccessible::GetRole(PRUint32 *_retval) { *_retval = ROLE_LISTITEM; return NS_OK; } /** * As a nsXULSelectOptionAccessible we can have the following states: * STATE_SELECTABLE * STATE_SELECTED * STATE_FOCUSED * STATE_FOCUSABLE */ NS_IMETHODIMP nsXULSelectOptionAccessible::GetState(PRUint32 *_retval) { nsXULMenuitemAccessible::GetState(_retval); nsCOMPtr item(do_QueryInterface(mDOMNode)); PRBool isSelected = PR_FALSE; item->GetSelected(&isSelected); if (isSelected) *_retval |= STATE_SELECTED; return NS_OK; } nsIFrame* nsXULSelectOptionAccessible::GetBoundsFrame() { nsCOMPtr menuListContent(do_QueryInterface(mDOMNode)); while (menuListContent) { nsCOMPtr menuListControl = do_QueryInterface(menuListContent); if (menuListControl) { PRBool isOpen; menuListControl->GetOpen(&isOpen); if (!isOpen) { nsCOMPtr presShell(GetPresShell()); if (!presShell) { return nsnull; } nsIFrame *menuListFrame = nsnull; presShell->GetPrimaryFrameFor(menuListContent, &menuListFrame); return menuListFrame; } break; } menuListContent = menuListContent->GetParent(); } return nsXULMenuitemAccessible::GetBoundsFrame(); } /** ------------------------------------------------------ */ /** Secondly, the Listbox widget */ /** ------------------------------------------------------ */ /** ----- nsXULListboxAccessible ----- */ /** Constructor */ nsXULListboxAccessible::nsXULListboxAccessible(nsIDOMNode* aDOMNode, nsIWeakReference* aShell): nsXULSelectableAccessible(aDOMNode, aShell) { } /** * As a nsXULListboxAccessible we can have the following states: * STATE_FOCUSED * STATE_READONLY * STATE_FOCUSABLE */ NS_IMETHODIMP nsXULListboxAccessible::GetState(PRUint32 *aState) { // Get focus status from base class nsAccessible::GetState(aState); // see if we are multiple select if so set ourselves as such nsCOMPtr element (do_QueryInterface(mDOMNode)); if (element) { nsAutoString selType; element->GetAttribute(NS_LITERAL_STRING("seltype"), selType); if (!selType.IsEmpty() && selType.EqualsLiteral("multiple")) *aState |= STATE_MULTISELECTABLE | STATE_EXTSELECTABLE; } return NS_OK; } /** * Our value is the label of our ( first ) selected child. */ NS_IMETHODIMP nsXULListboxAccessible::GetValue(nsAString& _retval) { _retval.Truncate(); nsCOMPtr select(do_QueryInterface(mDOMNode)); if (select) { nsCOMPtr selectedItem; select->GetSelectedItem(getter_AddRefs(selectedItem)); if (selectedItem) return selectedItem->GetLabel(_retval); } return NS_ERROR_FAILURE; } NS_IMETHODIMP nsXULListboxAccessible::GetRole(PRUint32 *_retval) { *_retval = ROLE_LIST; return NS_OK; } /** ----- nsXULListitemAccessible ----- */ /** Constructor */ nsXULListitemAccessible::nsXULListitemAccessible(nsIDOMNode* aDOMNode, nsIWeakReference* aShell): nsXULMenuitemAccessible(aDOMNode, aShell) { mIsCheckbox = PR_FALSE; nsCOMPtr listItem (do_QueryInterface(mDOMNode)); if (listItem) { nsAutoString typeString; nsresult res = listItem->GetAttribute(NS_LITERAL_STRING("type"), typeString); if (NS_SUCCEEDED(res) && typeString.Equals(NS_LITERAL_STRING("checkbox"))) mIsCheckbox = PR_TRUE; } } /** Inherit the ISupports impl from nsAccessible, we handle nsIAccessibleSelectable */ NS_IMPL_ISUPPORTS_INHERITED0(nsXULListitemAccessible, nsAccessible) /** * If there is a Listcell as a child ( not anonymous ) use it, otherwise * default to getting the name from GetXULName */ NS_IMETHODIMP nsXULListitemAccessible::GetName(nsAString& _retval) { nsCOMPtr child; if (NS_SUCCEEDED(mDOMNode->GetFirstChild(getter_AddRefs(child)))) { nsCOMPtr childElement (do_QueryInterface(child)); if (childElement) { nsAutoString tagName; childElement->GetLocalName(tagName); if (tagName.EqualsLiteral("listcell")) { childElement->GetAttribute(NS_LITERAL_STRING("label"), _retval); return NS_OK; } } } return GetXULName(_retval); } /** * */ NS_IMETHODIMP nsXULListitemAccessible::GetRole(PRUint32 *_retval) { if (mIsCheckbox) *_retval = ROLE_CHECKBUTTON; else *_retval = ROLE_LISTITEM; return NS_OK; } /** * */ NS_IMETHODIMP nsXULListitemAccessible::GetState(PRUint32 *_retval) { if (mIsCheckbox) { nsXULMenuitemAccessible::GetState(_retval); return NS_OK; } *_retval = STATE_FOCUSABLE | STATE_SELECTABLE; nsCOMPtr listItem (do_QueryInterface(mDOMNode)); if (listItem) { PRBool isSelected; listItem->GetSelected(&isSelected); if (isSelected) *_retval |= STATE_SELECTED; if (gLastFocusedNode == mDOMNode) { *_retval |= STATE_FOCUSED; } } return NS_OK; } NS_IMETHODIMP nsXULListitemAccessible::GetActionName(PRUint8 index, nsAString& _retval) { if (index == eAction_Click) { // check or uncheck PRUint32 state; GetState(&state); if (state & STATE_CHECKED) _retval = NS_LITERAL_STRING("uncheck"); else _retval = NS_LITERAL_STRING("check"); return NS_OK; } return NS_ERROR_INVALID_ARG; } /** ------------------------------------------------------ */ /** Finally, the Combobox widgets */ /** ------------------------------------------------------ */ /** ----- nsXULComboboxAccessible ----- */ /** Constructor */ nsXULComboboxAccessible::nsXULComboboxAccessible(nsIDOMNode* aDOMNode, nsIWeakReference* aShell): nsXULSelectableAccessible(aDOMNode, aShell) { } /** We are a combobox */ NS_IMETHODIMP nsXULComboboxAccessible::GetRole(PRUint32 *aRole) { nsCOMPtr content = do_QueryInterface(mDOMNode); if (!content) { return NS_ERROR_FAILURE; } nsAutoString type; content->GetAttr(kNameSpaceID_None, nsAccessibilityAtoms::type, type); *aRole = type.EqualsLiteral("autocomplete") ? ROLE_AUTOCOMPLETE : ROLE_COMBOBOX; return NS_OK; } /** * As a nsComboboxAccessible we can have the following states: * STATE_FOCUSED * STATE_READONLY * STATE_FOCUSABLE * STATE_HASPOPUP * STATE_EXPANDED * STATE_COLLAPSED */ NS_IMETHODIMP nsXULComboboxAccessible::GetState(PRUint32 *_retval) { // Get focus status from base class nsAccessible::GetState(_retval); nsCOMPtr menuList(do_QueryInterface(mDOMNode)); if (menuList) { PRBool isOpen; menuList->GetOpen(&isOpen); if (isOpen) { *_retval |= STATE_EXPANDED; } else { *_retval |= STATE_COLLAPSED; } PRBool isEditable; menuList->GetEditable(&isEditable); if (!isEditable) { *_retval |= STATE_READONLY; } } *_retval |= STATE_HASPOPUP | STATE_FOCUSABLE; return NS_OK; } NS_IMETHODIMP nsXULComboboxAccessible::GetValue(nsAString& _retval) { _retval.Truncate(); // The MSAA/ATK value is the option or text shown entered in the combobox nsCOMPtr menuList(do_QueryInterface(mDOMNode)); if (menuList) { return menuList->GetLabel(_retval); } return NS_ERROR_FAILURE; } NS_IMETHODIMP nsXULComboboxAccessible::GetDescription(nsAString& aDescription) { // Use description of currently focused option aDescription.Truncate(); nsCOMPtr menuList(do_QueryInterface(mDOMNode)); if (!menuList) { return NS_ERROR_FAILURE; // Shut down } nsCOMPtr focusedOption; menuList->GetSelectedItem(getter_AddRefs(focusedOption)); nsCOMPtr focusedOptionNode(do_QueryInterface(focusedOption)); if (focusedOptionNode) { nsCOMPtr accService = do_GetService("@mozilla.org/accessibilityService;1"); NS_ENSURE_TRUE(accService, NS_ERROR_FAILURE); nsCOMPtr focusedOptionAccessible; accService->GetAccessibleInWeakShell(focusedOptionNode, mWeakShell, getter_AddRefs(focusedOptionAccessible)); NS_ENSURE_TRUE(focusedOptionAccessible, NS_ERROR_FAILURE); return focusedOptionAccessible->GetDescription(aDescription); } return NS_OK; } NS_IMETHODIMP nsXULComboboxAccessible::GetChildCount(PRInt32 *aAccChildCount) { // Set menugenerated="true" on the menupopup node to generate the // sub-menu items if they have not been generated PRUint32 childIndex, numChildren = 0; nsCOMPtr childNode; nsCOMPtr nodeList; mDOMNode->GetChildNodes(getter_AddRefs(nodeList)); if (nodeList && NS_OK == nodeList->GetLength(&numChildren)) { for (childIndex = 0; childIndex < numChildren; childIndex++) { nodeList->Item(childIndex, getter_AddRefs(childNode)); nsAutoString nodeName; childNode->GetNodeName(nodeName); if (nodeName.Equals(NS_LITERAL_STRING("menupopup"))) { break; } } if (childIndex < numChildren) { nsCOMPtr element(do_QueryInterface(childNode)); if (element) { nsAutoString attr; element->GetAttribute(NS_LITERAL_STRING("menugenerated"), attr); if (!attr.Equals(NS_LITERAL_STRING("true"))) { element->SetAttribute(NS_LITERAL_STRING("menugenerated"), NS_LITERAL_STRING("true")); } } } } nsAutoString boxName; mDOMNode->GetNodeName(boxName); if (boxName.Equals(NS_LITERAL_STRING("textbox"))) { // autocomplete textbox also uses nsXULComboboxAccessible and we need walk anonymous children CacheChildren(PR_TRUE); } else { // Argument of PR_FALSE indicates we don't walk anonymous children for menuitems CacheChildren(PR_FALSE); } *aAccChildCount = mAccChildCount; return NS_OK; }