Tools/DumpRenderTree/chromium/AccessibilityController.h

/*
 * Copyright (C) 2010 Google 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:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 THE COPYRIGHT
 * OWNER 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 AccessibilityController_h
#define AccessibilityController_h

#include "AccessibilityUIElement.h"
#include "CppBoundClass.h"

namespace WebKit {
class WebAccessibilityObject;
class WebFrame;
}

class TestShell;

class AccessibilityController : public CppBoundClass {
public:
    explicit AccessibilityController(TestShell*);

    // Shadow to include accessibility initialization.
    void bindToJavascript(WebKit::WebFrame*, const WebKit::WebString& classname);
    void reset();

    void setFocusedElement(const WebKit::WebAccessibilityObject&);
    AccessibilityUIElement* getFocusedElement();
    AccessibilityUIElement* getRootElement();
    
    // This function sets a flag that tells the test_shell to dump all 
    // accessibility notifications.
    void dumpAccessibilityNotifications(const CppArgumentList&, CppVariant*);

public:
    // The following methods are not exposed to JavaScript.
    bool shouldDumpAccessibilityNotifications() { return m_dumpAccessibilityNotifications; }

private:
    // If true, the test_shell will dump all accessibility notifications.
    bool m_dumpAccessibilityNotifications;

    // Bound methods and properties
    void logFocusEventsCallback(const CppArgumentList&, CppVariant*);
    void logScrollingStartEventsCallback(const CppArgumentList&, CppVariant*);
    void fallbackCallback(const CppArgumentList&, CppVariant*);

    void focusedElementGetterCallback(CppVariant*);
    void rootElementGetterCallback(CppVariant*);

    WebKit::WebAccessibilityObject m_focusedElement;
    WebKit::WebAccessibilityObject m_rootElement;

    AccessibilityUIElementList m_elements;

    TestShell* m_shell;
};

#endif // AccessibilityController_h