vclxaccessiblestatusbaritem.cxx

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 .
 */
 
#include <standard/vclxaccessiblestatusbaritem.hxx>
#include <toolkit/helper/convert.hxx>
#include <helper/characterattributeshelper.hxx>
 
#include <com/sun/star/accessibility/AccessibleEventId.hpp>
#include <com/sun/star/accessibility/AccessibleRole.hpp>
#include <com/sun/star/accessibility/AccessibleStateType.hpp>
#include <com/sun/star/datatransfer/clipboard/XClipboard.hpp>
#include <com/sun/star/datatransfer/clipboard/XFlushableClipboard.hpp>
#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
#include <comphelper/accessiblecontexthelper.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <unotools/accessiblerelationsethelper.hxx>
#include <vcl/ctrl.hxx>
#include <vcl/svapp.hxx>
#include <vcl/unohelp2.hxx>
#include <vcl/status.hxx>
#include <vcl/settings.hxx>
#include <i18nlangtag/languagetag.hxx>
 
using namespace ::com::sun::star::accessibility;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star;
using namespace ::comphelper;
 
 
 
 
VCLXAccessibleStatusBarItem::VCLXAccessibleStatusBarItem( StatusBar* pStatusBar, sal_uInt16 nItemId )
    :m_pStatusBar( pStatusBar )
    ,m_nItemId( nItemId )
{
 
    m_sItemName = GetItemName();
    m_sItemText = GetItemText();
    m_bShowing  = IsShowing();
}
 
 
bool VCLXAccessibleStatusBarItem::IsShowing()
{
    bool bShowing = false;
 
    if ( m_pStatusBar )
        bShowing = m_pStatusBar->IsItemVisible( m_nItemId );
 
    return bShowing;
}
 
 
void VCLXAccessibleStatusBarItem::SetShowing( bool bShowing )
{
    if ( m_bShowing != bShowing )
    {
        Any aOldValue, aNewValue;
        if ( m_bShowing )
            aOldValue <<= AccessibleStateType::SHOWING;
        else
            aNewValue <<= AccessibleStateType::SHOWING;
        m_bShowing = bShowing;
        NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
    }
}
 
 
void VCLXAccessibleStatusBarItem::SetItemName( const OUString& sItemName )
{
    if ( m_sItemName != sItemName )
    {
        Any aOldValue, aNewValue;
        aOldValue <<= m_sItemName;
        aNewValue <<= sItemName;
        m_sItemName = sItemName;
        NotifyAccessibleEvent( AccessibleEventId::NAME_CHANGED, aOldValue, aNewValue );
    }
}
 
 
OUString VCLXAccessibleStatusBarItem::GetItemName()
{
    OUString sName;
    if ( m_pStatusBar )
        sName = m_pStatusBar->GetAccessibleName( m_nItemId );
 
    return sName;
}
 
 
void VCLXAccessibleStatusBarItem::SetItemText( const OUString& sItemText )
{
    Any aOldValue, aNewValue;
    if ( implInitTextChangedEvent( m_sItemText, sItemText, aOldValue, aNewValue ) )
    {
        m_sItemText = sItemText;
        NotifyAccessibleEvent( AccessibleEventId::TEXT_CHANGED, aOldValue, aNewValue );
    }
}
 
 
OUString VCLXAccessibleStatusBarItem::GetItemText()
{
    OUString sText;
    if ( m_pStatusBar )
        sText = m_pStatusBar->GetItemText( m_nItemId );
 
    return sText;
}
 
 
void VCLXAccessibleStatusBarItem::FillAccessibleStateSet( sal_Int64& rStateSet )
{
    rStateSet |= AccessibleStateType::ENABLED;
    rStateSet |= AccessibleStateType::SENSITIVE;
 
    rStateSet |= AccessibleStateType::VISIBLE;
 
    if ( IsShowing() )
        rStateSet |= AccessibleStateType::SHOWING;
}
 
 
// OCommonAccessibleComponent
 
 
awt::Rectangle VCLXAccessibleStatusBarItem::implGetBounds()
{
    awt::Rectangle aBounds( 0, 0, 0, 0 );
 
    if ( m_pStatusBar )
        aBounds = AWTRectangle( m_pStatusBar->GetItemRect( m_nItemId ) );
 
    return aBounds;
}
 
 
// OCommonAccessibleText
 
 
OUString VCLXAccessibleStatusBarItem::implGetText()
{
    return GetItemText();
}
 
 
lang::Locale VCLXAccessibleStatusBarItem::implGetLocale()
{
    return Application::GetSettings().GetLanguageTag().getLocale();
}
 
 
void VCLXAccessibleStatusBarItem::implGetSelection( sal_Int32& nStartIndex, sal_Int32& nEndIndex )
{
    nStartIndex = 0;
    nEndIndex = 0;
}
 
 
// XComponent
 
 
void VCLXAccessibleStatusBarItem::disposing()
{
    AccessibleTextHelper_BASE::disposing();
 
    m_pStatusBar = nullptr;
    m_sItemName.clear();
    m_sItemText.clear();
}
 
 
// XServiceInfo
 
 
OUString VCLXAccessibleStatusBarItem::getImplementationName()
{
    return "com.sun.star.comp.toolkit.AccessibleStatusBarItem";
}
 
 
sal_Bool VCLXAccessibleStatusBarItem::supportsService( const OUString& rServiceName )
{
    return cppu::supportsService(this, rServiceName);
}
 
 
Sequence< OUString > VCLXAccessibleStatusBarItem::getSupportedServiceNames()
{
    return { "com.sun.star.awt.AccessibleStatusBarItem" };
}
 
 
// XAccessible
 
 
Reference< XAccessibleContext > VCLXAccessibleStatusBarItem::getAccessibleContext(  )
{
    OExternalLockGuard aGuard( this );
 
    return this;
}
 
 
// XAccessibleContext
 
 
sal_Int64 VCLXAccessibleStatusBarItem::getAccessibleChildCount()
{
    OExternalLockGuard aGuard( this );
 
    return 0;
}
 
 
Reference< XAccessible > VCLXAccessibleStatusBarItem::getAccessibleChild( sal_Int64 )
{
    throw IndexOutOfBoundsException();
}
 
 
Reference< XAccessible > VCLXAccessibleStatusBarItem::getAccessibleParent(  )
{
    OExternalLockGuard aGuard( this );
 
    Reference< XAccessible > xParent;
    if ( m_pStatusBar )
        xParent = m_pStatusBar->GetAccessible();
 
    return xParent;
}
 
 
sal_Int64 VCLXAccessibleStatusBarItem::getAccessibleIndexInParent(  )
{
    OExternalLockGuard aGuard( this );
 
    sal_Int64 nIndexInParent = -1;
    if ( m_pStatusBar )
        nIndexInParent = m_pStatusBar->GetItemPos( m_nItemId );
 
    return nIndexInParent;
}
 
 
sal_Int16 VCLXAccessibleStatusBarItem::getAccessibleRole(  )
{
    OExternalLockGuard aGuard( this );
 
    return AccessibleRole::LABEL;
}
 
 
OUString VCLXAccessibleStatusBarItem::getAccessibleDescription(  )
{
    OExternalLockGuard aGuard( this );
 
    OUString sDescription;
    if ( m_pStatusBar )
        sDescription = m_pStatusBar->GetHelpText( m_nItemId );
 
    return sDescription;
}
 
 
OUString VCLXAccessibleStatusBarItem::getAccessibleName(  )
{
    OExternalLockGuard aGuard( this );
 
    return GetItemName();
}
 
 
Reference< XAccessibleRelationSet > VCLXAccessibleStatusBarItem::getAccessibleRelationSet(  )
{
    OExternalLockGuard aGuard( this );
 
    return new utl::AccessibleRelationSetHelper;
}
 
 
sal_Int64 VCLXAccessibleStatusBarItem::getAccessibleStateSet(  )
{
    OExternalLockGuard aGuard( this );
 
    sal_Int64 nStateSet = 0;
 
    if ( !rBHelper.bDisposed && !rBHelper.bInDispose )
    {
        FillAccessibleStateSet( nStateSet );
    }
    else
    {
        nStateSet |= AccessibleStateType::DEFUNC;
    }
 
    return nStateSet;
}
 
 
Locale VCLXAccessibleStatusBarItem::getLocale(  )
{
    OExternalLockGuard aGuard( this );
 
    return Application::GetSettings().GetLanguageTag().getLocale();
}
 
 
// XAccessibleComponent
 
 
Reference< XAccessible > VCLXAccessibleStatusBarItem::getAccessibleAtPoint( const awt::Point& )
{
    OExternalLockGuard aGuard( this );
 
    return Reference< XAccessible >();
}
 
 
void VCLXAccessibleStatusBarItem::grabFocus(  )
{
    // no focus for status bar items
}
 
 
sal_Int32 VCLXAccessibleStatusBarItem::getForeground(   )
{
    OExternalLockGuard aGuard( this );
 
    sal_Int32 nColor = 0;
    Reference< XAccessible > xParent = getAccessibleParent();
    if ( xParent.is() )
    {
        Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
        if ( xParentComp.is() )
            nColor = xParentComp->getForeground();
    }
 
    return nColor;
}
 
 
sal_Int32 VCLXAccessibleStatusBarItem::getBackground(  )
{
    OExternalLockGuard aGuard( this );
 
    sal_Int32 nColor = 0;
    Reference< XAccessible > xParent = getAccessibleParent();
    if ( xParent.is() )
    {
        Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
        if ( xParentComp.is() )
            nColor = xParentComp->getBackground();
    }
 
    return nColor;
}
 
 
// XAccessibleExtendedComponent
 
 
Reference< awt::XFont > VCLXAccessibleStatusBarItem::getFont(  )
{
    OExternalLockGuard aGuard( this );
 
    Reference< awt::XFont > xFont;
    Reference< XAccessible > xParent = getAccessibleParent();
    if ( xParent.is() )
    {
        Reference< XAccessibleExtendedComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
        if ( xParentComp.is() )
            xFont = xParentComp->getFont();
    }
 
    return xFont;
}
 
 
OUString VCLXAccessibleStatusBarItem::getTitledBorderText(  )
{
    OExternalLockGuard aGuard( this );
 
    return GetItemText();
}
 
 
OUString VCLXAccessibleStatusBarItem::getToolTipText(  )
{
    OExternalLockGuard aGuard( this );
 
    return OUString();
}
 
 
// XAccessibleText
 
OUString VCLXAccessibleStatusBarItem::getText()
{
    OExternalLockGuard aGuard( this );
 
    return GetItemText();
}
 
OUString VCLXAccessibleStatusBarItem::getTextRange(sal_Int32 nStartIndex, sal_Int32 nEndIndex)
{
    OExternalLockGuard aGuard( this );
 
    return OCommonAccessibleText::implGetTextRange(GetItemText(), nStartIndex, nEndIndex);
}
 
 
sal_Int32 VCLXAccessibleStatusBarItem::getCharacterCount()
{
    OExternalLockGuard aGuard( this );
 
    return GetItemText().getLength();
}
 
sal_Unicode VCLXAccessibleStatusBarItem::getCharacter( sal_Int32 nIndex )
{
     OExternalLockGuard aGuard( this );
 
     return OCommonAccessibleText::implGetCharacter( GetItemText(), nIndex );
}
 
sal_Int32 VCLXAccessibleStatusBarItem::getCaretPosition()
{
    OExternalLockGuard aGuard( this );
 
    return -1;
}
 
 
sal_Bool VCLXAccessibleStatusBarItem::setCaretPosition( sal_Int32 nIndex )
{
    OExternalLockGuard aGuard( this );
 
    if ( !implIsValidRange( nIndex, nIndex, GetItemText().getLength() ) )
        throw IndexOutOfBoundsException();
 
    return false;
}
 
 
Sequence< PropertyValue > VCLXAccessibleStatusBarItem::getCharacterAttributes( sal_Int32 nIndex, const Sequence< OUString >& aRequestedAttributes )
{
    OExternalLockGuard aGuard( this );
 
    Sequence< PropertyValue > aValues;
    OUString sText( implGetText() );
 
    if ( !implIsValidIndex( nIndex, sText.getLength() ) )
        throw IndexOutOfBoundsException();
 
    if ( m_pStatusBar )
    {
        vcl::Font aFont = m_pStatusBar->GetFont();
        sal_Int32 nBackColor = getBackground();
        sal_Int32 nColor = getForeground();
        aValues = CharacterAttributesHelper( aFont, nBackColor, nColor )
            .GetCharacterAttributes( aRequestedAttributes );
    }
 
    return aValues;
}
 
 
awt::Rectangle VCLXAccessibleStatusBarItem::getCharacterBounds( sal_Int32 nIndex )
{
    OExternalLockGuard aGuard( this );
 
    if ( !implIsValidIndex( nIndex, implGetText().getLength() ) )
        throw IndexOutOfBoundsException();
 
    awt::Rectangle aBounds( 0, 0, 0, 0 );
    if ( m_pStatusBar )
    {
        vcl::ControlLayoutData aLayoutData;
        tools::Rectangle aItemRect = m_pStatusBar->GetItemRect( m_nItemId );
        m_pStatusBar->RecordLayoutData( &aLayoutData, aItemRect );
        tools::Rectangle aCharRect = aLayoutData.GetCharacterBounds( nIndex );
        aCharRect.Move( -aItemRect.Left(), -aItemRect.Top() );
        aBounds = AWTRectangle( aCharRect );
    }
 
    return aBounds;
}
 
 
sal_Int32 VCLXAccessibleStatusBarItem::getIndexAtPoint( const awt::Point& aPoint )
{
    OExternalLockGuard aGuard( this );
 
    sal_Int32 nIndex = -1;
    if ( m_pStatusBar )
    {
        vcl::ControlLayoutData aLayoutData;
        tools::Rectangle aItemRect = m_pStatusBar->GetItemRect( m_nItemId );
        m_pStatusBar->RecordLayoutData( &aLayoutData, aItemRect );
        Point aPnt( VCLPoint( aPoint ) );
        aPnt += aItemRect.TopLeft();
        nIndex = aLayoutData.GetIndexForPoint( aPnt );
    }
 
    return nIndex;
}
 
 
sal_Bool VCLXAccessibleStatusBarItem::setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
{
    OExternalLockGuard aGuard( this );
 
    if ( !implIsValidRange( nStartIndex, nEndIndex, implGetText().getLength() ) )
        throw IndexOutOfBoundsException();
 
    return false;
}
 
 
sal_Bool VCLXAccessibleStatusBarItem::copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
{
    OExternalLockGuard aGuard( this );
 
    bool bReturn = false;
 
    if ( m_pStatusBar )
    {
        Reference< datatransfer::clipboard::XClipboard > xClipboard = m_pStatusBar->GetClipboard();
        if ( xClipboard.is() )
        {
            OUString sText( implGetTextRange( GetItemText(), nStartIndex, nEndIndex ) );
 
            rtl::Reference<vcl::unohelper::TextDataObject> pDataObj = new vcl::unohelper::TextDataObject( sText );
 
            SolarMutexReleaser aReleaser;
            xClipboard->setContents( pDataObj, nullptr );
 
            Reference< datatransfer::clipboard::XFlushableClipboard > xFlushableClipboard( xClipboard, uno::UNO_QUERY );
            if( xFlushableClipboard.is() )
                xFlushableClipboard->flushClipboard();
 
            bReturn = true;
        }
    }
 
    return bReturn;
}
 
 
sal_Bool VCLXAccessibleStatusBarItem::scrollSubstringTo( sal_Int32, sal_Int32, AccessibleScrollType )
{
    return false;
}
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */