LibreOffice/core
1
0
Fork 0
mirror of https://github.com/LibreOffice/core.git synced 2025-07-22 01:09:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
core/svx/source/inc/charmapacc.hxx
Michael Weghorn 671b8cad97 a11y: Rename OAccessibleComponentHelper to OAccessible 
The helper class used to implement less functionality
in the past and was used less than it is now.
But by now it is the central helper/base class used
by most a11y classes.

Since

    commit 22049f633b
    Author: Michael Weghorn <m.weghorn@posteo.de>
    Date:   Mon May 26 12:24:52 2025 +0200

        vcl a11y: Let OAccessibleComponentHelper implement XAccessible

it also implements the XAccessible interface.

That will allow to switch parameters and class members
from the abstract XAccessible interface to using this
more concrete C++ base class in various places.

Rename the class to OAccessible to account for the
new responsibilities, and adjust its doc accordingly.

Renaming source and header file will be done in a
separate commit to simplify (git) keeping track.

Change-Id: I33210b47cda5f71820a3c0fa657e4c3548d45732
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/186952
Tested-by: Jenkins
Reviewed-by: Michael Weghorn <m.weghorn@posteo.de>
2025-06-26 13:09:41 +02:00

205 lines
9.3 KiB
C++
Raw Permalink Blame History

/* -*- 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 .
*/
#ifndef INCLUDED_SVX_SOURCE_INC_CHARMAPACC_HXX
#define INCLUDED_SVX_SOURCE_INC_CHARMAPACC_HXX
#include <comphelper/accessibleselectionhelper.hxx>
#include <com/sun/star/accessibility/XAccessibleAction.hpp>
#include <com/sun/star/accessibility/XAccessibleTable.hpp>
#include <cppuhelper/implbase.hxx>
#include <tools/gen.hxx>
#include <rtl/ref.hxx>
#include <vector>
class SvxShowCharSet;
namespace svx
{
class SvxShowCharSetAcc;
class SvxShowCharSetItemAcc;
// - SvxShowCharSetItem -
/** Simple struct to hold some information about the single items of the table.
*/
struct SvxShowCharSetItem
{
SvxShowCharSet& mrParent;
sal_uInt16 mnId;
OUString maText;
tools::Rectangle maRect;
rtl::Reference<SvxShowCharSetItemAcc> m_xItem;
SvxShowCharSetAcc* m_pParent;
SvxShowCharSetItem( SvxShowCharSet& rParent, SvxShowCharSetAcc* _pParent, sal_uInt16 _nPos );
~SvxShowCharSetItem();
const rtl::Reference< SvxShowCharSetItemAcc > & GetAccessible();
};
// - SvxShowCharSetAcc -
/** The table implementation of the vcl control.
*/
class SvxShowCharSetAcc final
: public cppu::ImplInheritanceHelper<::comphelper::OAccessibleSelectionHelper,
css::accessibility::XAccessibleTable>
{
::std::vector< rtl::Reference< SvxShowCharSetItemAcc > > m_aChildren;
SvxShowCharSet* m_pParent; // the vcl control
virtual void SAL_CALL disposing() override;
public:
SvxShowCharSetAcc(SvxShowCharSet* pParent);
// XAccessibleComponent
virtual void SAL_CALL grabFocus( ) override;
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint( const css::awt::Point& aPoint ) override;
// OAccessible
// XAccessibleContext - still waiting to be overwritten
virtual sal_Int64 SAL_CALL getAccessibleChildCount() override;
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int64 i ) override;
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent( ) override;
virtual sal_Int16 SAL_CALL getAccessibleRole( ) override;
virtual OUString SAL_CALL getAccessibleDescription( ) override;
virtual OUString SAL_CALL getAccessibleName( ) override;
virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet( ) override;
virtual sal_Int64 SAL_CALL getAccessibleStateSet( ) override;
virtual sal_Int32 SAL_CALL getForeground( ) override;
virtual sal_Int32 SAL_CALL getBackground( ) override;
// XAccessibleTable
virtual sal_Int32 SAL_CALL getAccessibleRowCount( ) override;
virtual sal_Int32 SAL_CALL getAccessibleColumnCount( ) override;
virtual OUString SAL_CALL getAccessibleRowDescription( sal_Int32 nRow ) override;
virtual OUString SAL_CALL getAccessibleColumnDescription( sal_Int32 nColumn ) 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::XAccessibleTable > SAL_CALL getAccessibleRowHeaders( ) override;
virtual css::uno::Reference< css::accessibility::XAccessibleTable > SAL_CALL getAccessibleColumnHeaders( ) override;
virtual css::uno::Sequence< sal_Int32 > SAL_CALL getSelectedAccessibleRows( ) override;
virtual css::uno::Sequence< sal_Int32 > SAL_CALL getSelectedAccessibleColumns( ) override;
virtual sal_Bool SAL_CALL isAccessibleRowSelected( sal_Int32 nRow ) override;
virtual sal_Bool SAL_CALL isAccessibleColumnSelected( sal_Int32 nColumn ) override;
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleCellAt( 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_Bool SAL_CALL isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn ) 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;
void fireEvent(
const sal_Int16 _nEventId,
const css::uno::Any& _rOldValue,
const css::uno::Any& _rNewValue
)
{
NotifyAccessibleEvent(_nEventId,_rOldValue,_rNewValue);
}
void clearCharSetControl() { m_pParent = nullptr; }
private:
virtual ~SvxShowCharSetAcc() override;
// OCommonAccessibleSelection
// return if the specified child is visible => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx)
virtual bool
implIsSelected( sal_Int64 nAccessibleChildIndex ) override;
// select the specified child => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx)
virtual void
implSelect( sal_Int64 nAccessibleChildIndex, bool bSelect ) override;
// OAccessible
/// implements the calculation of the bounding rectangle - still waiting to be overwritten
virtual css::awt::Rectangle implGetBounds( ) override;
};
// - SvxShowCharSetItemAcc -
/** The child implementation of the table.
*/
class SvxShowCharSetItemAcc final
: public cppu::ImplInheritanceHelper<::comphelper::OAccessible,
css::accessibility::XAccessibleAction>
{
private:
SvxShowCharSetItem* mpParent;
virtual ~SvxShowCharSetItemAcc() override;
// OAccessible
/// implements the calculation of the bounding rectangle - still waiting to be overwritten
virtual css::awt::Rectangle implGetBounds( ) override;
public:
SvxShowCharSetItemAcc( SvxShowCharSetItem* pParent );
void ParentDestroyed();
// XAccessibleComponent
virtual void SAL_CALL grabFocus( ) override;
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint( const css::awt::Point& aPoint ) override;
// OAccessible
// XAccessibleContext - still waiting to be overwritten
virtual sal_Int64 SAL_CALL getAccessibleChildCount( ) override;
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int64 i ) override;
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent( ) override;
virtual sal_Int16 SAL_CALL getAccessibleRole( ) override;
virtual OUString SAL_CALL getAccessibleDescription( ) override;
virtual OUString SAL_CALL getAccessibleName( ) override;
virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet( ) override;
virtual sal_Int64 SAL_CALL getAccessibleStateSet( ) override;
virtual sal_Int32 SAL_CALL getForeground( ) override { return mpParent->m_pParent->getForeground(); }
virtual sal_Int32 SAL_CALL getBackground( ) override { return mpParent->m_pParent->getBackground(); }
// XAccessibleAction
virtual sal_Int32 SAL_CALL getAccessibleActionCount( ) override;
virtual sal_Bool SAL_CALL doAccessibleAction ( sal_Int32 nIndex ) override;
virtual OUString SAL_CALL getAccessibleActionDescription ( sal_Int32 nIndex ) override;
virtual css::uno::Reference< css::accessibility::XAccessibleKeyBinding > SAL_CALL getAccessibleActionKeyBinding( sal_Int32 nIndex ) override;
void fireEvent(
const sal_Int16 _nEventId,
const css::uno::Any& _rOldValue,
const css::uno::Any& _rNewValue
)
{
NotifyAccessibleEvent(_nEventId,_rOldValue,_rNewValue);
}
};
}
#endif // INCLUDED_SVX_SOURCE_INC_CHARMAPACC_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in New Issue View Git Blame Copy Permalink