/* -*- Mode: C++; tab-width: 2; 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): * Aaron Leventhal (aaronl@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 ***** */ // NOTE: alphabetically ordered #include "nsXULFormControlAccessible.h" #include "nsHTMLFormControlAccessible.h" #include "nsAccessibilityAtoms.h" #include "nsAccessibleTreeWalker.h" #include "nsXULMenuAccessible.h" #include "nsIDOMHTMLInputElement.h" #include "nsIDOMNSEditableElement.h" #include "nsIDOMXULButtonElement.h" #include "nsIDOMXULCheckboxElement.h" #include "nsIDOMXULMenuListElement.h" #include "nsIDOMXULSelectCntrlItemEl.h" #include "nsIDOMXULTextboxElement.h" #include "nsIEditor.h" #include "nsIFrame.h" #include "nsINameSpaceManager.h" #include "nsITextControlFrame.h" #include "nsIPresShell.h" /** * XUL Button: can contain arbitrary HTML content */ /** * Default Constructor */ // Don't inherit from nsFormControlAccessible - it doesn't allow children and a button can have a dropmarker child nsXULButtonAccessible::nsXULButtonAccessible(nsIDOMNode* aNode, nsIWeakReference* aShell): nsAccessibleWrap(aNode, aShell) { } /** * Only one actions available */ NS_IMETHODIMP nsXULButtonAccessible::GetNumActions(PRUint8 *_retval) { *_retval = 1; return NS_OK; } /** * Return the name of our only action */ NS_IMETHODIMP nsXULButtonAccessible::GetActionName(PRUint8 aIndex, nsAString& aName) { if (aIndex == eAction_Click) { aName.AssignLiteral("press"); return NS_OK; } return NS_ERROR_INVALID_ARG; } /** * Tell the button to do it's action */ NS_IMETHODIMP nsXULButtonAccessible::DoAction(PRUint8 index) { if (index == 0) { return DoCommand(); } return NS_ERROR_INVALID_ARG; } /** * We are a pushbutton */ NS_IMETHODIMP nsXULButtonAccessible::GetRole(PRUint32 *_retval) { *_retval = nsIAccessibleRole::ROLE_PUSHBUTTON; return NS_OK; } /** * Possible states: focused, focusable, unavailable(disabled) */ NS_IMETHODIMP nsXULButtonAccessible::GetState(PRUint32 *aState, PRUint32 *aExtraState) { // get focus and disable status from base class nsresult rv = nsAccessible::GetState(aState, aExtraState); NS_ENSURE_SUCCESS(rv, rv); if (!mDOMNode) return NS_OK; PRBool disabled = PR_FALSE; nsCOMPtr xulFormElement(do_QueryInterface(mDOMNode)); if (xulFormElement) { xulFormElement->GetDisabled(&disabled); if (disabled) *aState |= nsIAccessibleStates::STATE_UNAVAILABLE; else *aState |= nsIAccessibleStates::STATE_FOCUSABLE; } // Buttons can be checked -- they simply appear pressed in rather than checked nsCOMPtr xulButtonElement(do_QueryInterface(mDOMNode)); if (xulButtonElement) { nsAutoString type; xulButtonElement->GetType(type); if (type.EqualsLiteral("checkbox") || type.EqualsLiteral("radio")) { *aState |= nsIAccessibleStates::STATE_CHECKABLE; PRBool checked = PR_FALSE; PRInt32 checkState = 0; xulButtonElement->GetChecked(&checked); if (checked) { *aState |= nsIAccessibleStates::STATE_PRESSED; xulButtonElement->GetCheckState(&checkState); if (checkState == nsIDOMXULButtonElement::CHECKSTATE_MIXED) { *aState |= nsIAccessibleStates::STATE_MIXED; } } } } nsCOMPtr element(do_QueryInterface(mDOMNode)); if (element) { PRBool isDefault = PR_FALSE; element->HasAttribute(NS_LITERAL_STRING("default"), &isDefault) ; if (isDefault) *aState |= nsIAccessibleStates::STATE_DEFAULT; nsAutoString type; element->GetAttribute(NS_LITERAL_STRING("type"), type); if (type.EqualsLiteral("menu") || type.EqualsLiteral("menu-button")) { *aState |= nsIAccessibleStates::STATE_HASPOPUP; } } return NS_OK; } void nsXULButtonAccessible::CacheChildren() { // An XUL button accessible may have 1 child dropmarker accessible if (!mWeakShell) { mAccChildCount = eChildCountUninitialized; return; // This outer doc node has been shut down } if (mAccChildCount == eChildCountUninitialized) { mAccChildCount = 0; // Avoid reentry SetFirstChild(nsnull); PRBool allowsAnonChildren = PR_FALSE; GetAllowsAnonChildAccessibles(&allowsAnonChildren); nsAccessibleTreeWalker walker(mWeakShell, mDOMNode, allowsAnonChildren); walker.GetFirstChild(); nsCOMPtr dropMarkerAccessible; while (walker.mState.accessible) { dropMarkerAccessible = walker.mState.accessible; walker.GetNextSibling(); } // If the anonymous tree walker can find accessible children, // and the last one is a push button, then use it as the only accessible // child -- because this is the scenario where we have a dropmarker child if (dropMarkerAccessible) { PRUint32 role; if (NS_SUCCEEDED(dropMarkerAccessible->GetRole(&role)) && role == nsIAccessibleRole::ROLE_PUSHBUTTON) { SetFirstChild(dropMarkerAccessible); nsCOMPtr privChildAcc = do_QueryInterface(dropMarkerAccessible); privChildAcc->SetNextSibling(nsnull); privChildAcc->SetParent(this); mAccChildCount = 1; } } } } /** * XUL Dropmarker: can contain arbitrary HTML content */ /** * Default Constructor */ nsXULDropmarkerAccessible::nsXULDropmarkerAccessible(nsIDOMNode* aNode, nsIWeakReference* aShell): nsFormControlAccessible(aNode, aShell) { } /** * Only one action available */ NS_IMETHODIMP nsXULDropmarkerAccessible::GetNumActions(PRUint8 *aResult) { *aResult = 1; return NS_OK; } PRBool nsXULDropmarkerAccessible::DropmarkerOpen(PRBool aToggleOpen) { PRBool isOpen = PR_FALSE; nsCOMPtr parentButtonNode; mDOMNode->GetParentNode(getter_AddRefs(parentButtonNode)); nsCOMPtr parentButtonElement(do_QueryInterface(parentButtonNode)); if (parentButtonElement) { parentButtonElement->GetOpen(&isOpen); if (aToggleOpen) parentButtonElement->SetOpen(!isOpen); } else { nsCOMPtr parentMenuListElement(do_QueryInterface(parentButtonNode)); if (parentMenuListElement) { parentMenuListElement->GetOpen(&isOpen); if (aToggleOpen) parentMenuListElement->SetOpen(!isOpen); } } return isOpen; } /** * Return the name of our only action */ NS_IMETHODIMP nsXULDropmarkerAccessible::GetActionName(PRUint8 aIndex, nsAString& aName) { if (aIndex == eAction_Click) { if (DropmarkerOpen(PR_FALSE)) aName.AssignLiteral("close"); else aName.AssignLiteral("open"); return NS_OK; } return NS_ERROR_INVALID_ARG; } /** * Tell the Dropmarker to do it's action */ NS_IMETHODIMP nsXULDropmarkerAccessible::DoAction(PRUint8 index) { if (index == eAction_Click) { DropmarkerOpen(PR_TRUE); // Reverse the open attribute return NS_OK; } return NS_ERROR_INVALID_ARG; } /** * We are a pushbutton */ NS_IMETHODIMP nsXULDropmarkerAccessible::GetRole(PRUint32 *aResult) { *aResult = nsIAccessibleRole::ROLE_PUSHBUTTON; return NS_OK; } NS_IMETHODIMP nsXULDropmarkerAccessible::GetState(PRUint32 *aState, PRUint32 *aExtraState) { *aState = 0; if (!mDOMNode) { if (aExtraState) { *aExtraState = nsIAccessibleStates::EXT_STATE_DEFUNCT; } return NS_OK; } if (aExtraState) *aExtraState = 0; if (DropmarkerOpen(PR_FALSE)) *aState = nsIAccessibleStates::STATE_PRESSED; return NS_OK; } /** * XUL checkbox */ /** * Default Constructor */ nsXULCheckboxAccessible::nsXULCheckboxAccessible(nsIDOMNode* aNode, nsIWeakReference* aShell): nsFormControlAccessible(aNode, aShell) { } /** * We are a CheckButton */ NS_IMETHODIMP nsXULCheckboxAccessible::GetRole(PRUint32 *_retval) { *_retval = nsIAccessibleRole::ROLE_CHECKBUTTON; return NS_OK; } /** * Only one action available */ NS_IMETHODIMP nsXULCheckboxAccessible::GetNumActions(PRUint8 *_retval) { *_retval = 1; return NS_OK; } /** * Return the name of our only action */ NS_IMETHODIMP nsXULCheckboxAccessible::GetActionName(PRUint8 aIndex, nsAString& aName) { if (aIndex == eAction_Click) { // check or uncheck PRUint32 state; GetState(&state, nsnull); if (state & nsIAccessibleStates::STATE_CHECKED) aName.AssignLiteral("uncheck"); else aName.AssignLiteral("check"); return NS_OK; } return NS_ERROR_INVALID_ARG; } /** * Tell the checkbox to do its only action -- check( or uncheck) itself */ NS_IMETHODIMP nsXULCheckboxAccessible::DoAction(PRUint8 index) { if (index == eAction_Click) { return DoCommand(); } return NS_ERROR_INVALID_ARG; } /** * Possible states: focused, focusable, unavailable(disabled), checked */ NS_IMETHODIMP nsXULCheckboxAccessible::GetState(PRUint32 *aState, PRUint32 *aExtraState) { // Get focus and disable status from base class nsresult rv = nsFormControlAccessible::GetState(aState, aExtraState); NS_ENSURE_SUCCESS(rv, rv); if (!mDOMNode) return NS_OK; *aState |= nsIAccessibleStates::STATE_CHECKABLE; // Determine Checked state nsCOMPtr xulCheckboxElement(do_QueryInterface(mDOMNode)); if (xulCheckboxElement) { PRBool checked = PR_FALSE; xulCheckboxElement->GetChecked(&checked); if (checked) { *aState |= nsIAccessibleStates::STATE_CHECKED; PRInt32 checkState = 0; xulCheckboxElement->GetCheckState(&checkState); if (checkState == nsIDOMXULCheckboxElement::CHECKSTATE_MIXED) *aState |= nsIAccessibleStates::STATE_MIXED; } } return NS_OK; } /** * XUL groupbox */ nsXULGroupboxAccessible::nsXULGroupboxAccessible(nsIDOMNode* aNode, nsIWeakReference* aShell): nsAccessibleWrap(aNode, aShell) { } NS_IMETHODIMP nsXULGroupboxAccessible::GetRole(PRUint32 *aRole) { *aRole = nsIAccessibleRole::ROLE_GROUPING; return NS_OK; } NS_IMETHODIMP nsXULGroupboxAccessible::GetName(nsAString& aName) { aName.Truncate(); nsCOMPtr label; GetAccessibleRelated(nsIAccessibleRelation::RELATION_LABELLED_BY, getter_AddRefs(label)); if (label) { return label->GetName(aName); } return NS_OK; } NS_IMETHODIMP nsXULGroupboxAccessible::GetAccessibleRelated(PRUint32 aRelationType, nsIAccessible **aRelated) { *aRelated = nsnull; nsresult rv = nsAccessibleWrap::GetAccessibleRelated(aRelationType, aRelated); if (NS_FAILED(rv) || *aRelated) { // Either the node is shut down, or another relation mechanism has been used return rv; } if (aRelationType == nsIAccessibleRelation::RELATION_LABELLED_BY) { // The label for xul:groupbox is generated from xul:label that is // inside the anonymous content of the xul:caption. // The xul:label has an accessible object but the xul:caption does not nsCOMPtr testLabelAccessible; while (NextChild(testLabelAccessible)) { if (Role(testLabelAccessible) == nsIAccessibleRole::ROLE_LABEL) { // Ensure that it's our label nsCOMPtr testGroupboxAccessible; testLabelAccessible->GetAccessibleRelated(nsIAccessibleRelation::RELATION_LABEL_FOR, getter_AddRefs(testGroupboxAccessible)); if (testGroupboxAccessible == this) { // The