AccessibleBrowseBoxTableBase.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
 
 
#pragma once
 
#include <extended/AccessibleBrowseBoxBase.hxx>
#include <cppuhelper/implbase1.hxx>
#include <com/sun/star/accessibility/XAccessibleTable.hpp>
 
 
namespace accessibility {
 
typedef ::cppu::ImplHelper1< css::accessibility::XAccessibleTable >
        AccessibleBrowseBoxTableImplHelper;
 
class AccessibleBrowseBoxTableBase :
    public BrowseBoxAccessibleElement,
    public AccessibleBrowseBoxTableImplHelper
{
public:
    AccessibleBrowseBoxTableBase(
        const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
        ::vcl::IAccessibleTableProvider& rBrowseBox,
        AccessibleBrowseBoxObjType eObjType );
 
protected:
    virtual ~AccessibleBrowseBoxTableBase() override = default;
 
public:
    // XAccessibleContext
 
    virtual sal_Int64 SAL_CALL getAccessibleChildCount() override;
 
    virtual sal_Int16 SAL_CALL getAccessibleRole() override;
 
    /*  Derived classes have to implement:
        -   getAccessibleChild,
        -   getAccessibleIndexInParent. */
 
    // XAccessibleComponent
 
    /*  Derived classes have to implement:
        -   getAccessibleAt,
        -   grabFocus. */
 
    // XAccessibleTable
 
    virtual sal_Int32 SAL_CALL getAccessibleRowCount() override;
 
    virtual sal_Int32 SAL_CALL getAccessibleColumnCount() override;
 
    virtual sal_Int32 SAL_CALL
    getAccessibleRowExtentAt( sal_Int32 nRow, sal_Int32 nColumn ) override;
 
    virtual sal_Int32 SAL_CALL
    getAccessibleColumnExtentAt( sal_Int32 nRow, sal_Int32 nColumn ) override;
 
    virtual css::uno::Reference<
        css::accessibility::XAccessible > SAL_CALL
    getAccessibleCaption() override;
 
    virtual css::uno::Reference<
        css::accessibility::XAccessible > SAL_CALL
    getAccessibleSummary() override;
 
    virtual sal_Int64 SAL_CALL getAccessibleIndex( sal_Int32 nRow, sal_Int32 nColumn ) override;
 
    virtual sal_Int32 SAL_CALL getAccessibleRow( sal_Int64 nChildIndex ) override;
 
    virtual sal_Int32 SAL_CALL getAccessibleColumn( sal_Int64 nChildIndex ) override;
 
    /*  Derived classes have to implement:
        -   getAccessibleRowDescription,
        -   getAccessibleColumnDescription,
        -   getAccessibleRowHeaders,
        -   getAccessibleColumnHeaders,
        -   getSelectedAccessibleRows,
        -   getSelectedAccessibleColumns,
        -   isAccessibleRowSelected,
        -   isAccessibleColumnSelected,
        -   getAccessibleCellAt,
        -   isAccessibleSelected. */
 
    // XInterface
 
    css::uno::Any SAL_CALL queryInterface( const css::uno::Type& rType ) override;
 
    virtual void SAL_CALL acquire() noexcept override;
 
    virtual void SAL_CALL release() noexcept override;
 
    // XTypeProvider
 
    virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() override;
 
    virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() override;
 
    // XServiceInfo
 
    /*  Derived classes have to implement:
        -   getImplementationName */
 
protected:
    // internal virtual methods
 
    virtual sal_Int32 implGetRowCount() const;
    virtual sal_Int32 implGetColumnCount() const;
 
    // internal helper methods
 
    bool implHasHandleColumn() const;
 
    sal_uInt16 implToVCLColumnPos( sal_Int32 nColumn ) const;
 
    sal_Int64 implGetChildCount() const;
 
    sal_Int32 implGetRow( sal_Int64 nChildIndex ) const;
    sal_Int32 implGetColumn( sal_Int64 nChildIndex ) const;
 
    bool implIsRowSelected( sal_Int32 nRow ) const;
    bool implIsColumnSelected( sal_Int32 nColumn ) const;
 
    void implSelectRow( sal_Int32 nRow, bool bSelect );
    void implSelectColumn( sal_Int32 nColumnPos, bool bSelect );
 
    sal_Int32 implGetSelectedRowCount() const;
    sal_Int32 implGetSelectedColumnCount() const;
 
    void implGetSelectedRows( css::uno::Sequence< sal_Int32 >& rSeq );
    void implGetSelectedColumns( css::uno::Sequence< sal_Int32 >& rSeq );
 
    void ensureIsValidRow( sal_Int32 nRow );
    void ensureIsValidColumn( sal_Int32 nColumn );
    void ensureIsValidAddress( sal_Int32 nRow, sal_Int32 nColumn );
    void ensureIsValidIndex( sal_Int64 nChildIndex );
};
 
 
} // namespace accessibility
 
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */