Source/modules/accessibility/AXTableColumn.h

/*
 * Copyright (C) 2008 Apple 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:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  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.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") 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 APPLE AND ITS 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 APPLE OR ITS 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 AXTableColumn_h
#define AXTableColumn_h

#include "modules/ModulesExport.h"
#include "modules/accessibility/AXMockObject.h"
#include "modules/accessibility/AXTable.h"

namespace blink {

class AXObjectCacheImpl;
class LayoutTableSection;

class MODULES_EXPORT AXTableColumn final : public AXMockObject {

private:
    explicit AXTableColumn(AXObjectCacheImpl&);

public:
    static AXTableColumn* create(AXObjectCacheImpl&);
    ~AXTableColumn() override;

    // retrieves the topmost "column" header (th)
    AXObject* headerObject();
    // retrieves the "column" headers (th, scope) from top to bottom
    void headerObjectsForColumn(AccessibilityChildrenVector&);

    AccessibilityRole roleValue() const override { return ColumnRole; }

    void setColumnIndex(int columnIndex) { m_columnIndex = columnIndex; }
    int columnIndex() const { return m_columnIndex; }

    void addChildren() override;
    void setParent(AXObject*) override;

    LayoutRect elementRect() const override;

private:
    unsigned m_columnIndex;
    LayoutRect m_columnRect;

    bool isTableCol() const override { return true; }
    bool computeAccessibilityIsIgnored(IgnoredReasons* = nullptr) const override;
};

DEFINE_AX_OBJECT_TYPE_CASTS(AXTableColumn, isTableCol());

} // namespace blink

#endif // AXTableColumn_h