libreoffice/svx/source/accessibility/DescriptionGenerator.cxx

/* -*- 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 <DescriptionGenerator.hxx>
#include <com/sun/star/beans/PropertyState.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/beans/XPropertyState.hpp>
#include <com/sun/star/container/XNamed.hpp>
#include <com/sun/star/drawing/XShape.hpp>
#include <utility>
#include <vcl/svapp.hxx>

// Includes for string resources.
#include <svx/strings.hrc>
#include <svx/dialmgr.hxx>

#include "lookupcolorname.hxx"

using namespace ::com::sun::star;

namespace accessibility
{
DescriptionGenerator::DescriptionGenerator(uno::Reference<drawing::XShape> xShape)
    : mxShape(std::move(xShape))
    , mxSet(mxShape, uno::UNO_QUERY)
    , mbIsFirstProperty(true)
{
}

DescriptionGenerator::~DescriptionGenerator() {}

void DescriptionGenerator::Initialize(TranslateId pResourceId)
{
    // Get the string from the resource for the specified id.
    OUString sPrefix;
    {
        SolarMutexGuard aGuard;
        sPrefix = SvxResId(pResourceId);
    }

    // Forward the call with the resulting string.
    Initialize(sPrefix);
}

void DescriptionGenerator::Initialize(std::u16string_view sPrefix)
{
    msDescription = sPrefix;
    if (!mxSet.is())
        return;

    {
        SolarMutexGuard aGuard;

        msDescription.append(' ');
        msDescription.append(SvxResId(RID_SVXSTR_A11Y_WITH));
        msDescription.append(' ');

        msDescription.append(SvxResId(RID_SVXSTR_A11Y_STYLE));
        msDescription.append('=');
    }

    try
    {
        if (mxSet.is())
        {
            uno::Any aValue = mxSet->getPropertyValue(u"Style"_ustr);
            uno::Reference<container::XNamed> xStyle(aValue, uno::UNO_QUERY);
            if (xStyle.is())
                msDescription.append(xStyle->getName());
        }
        else
            msDescription.append("<no style>");
    }
    catch (const css::beans::UnknownPropertyException&)
    {
        msDescription.append("<unknown>");
    }
}

OUString DescriptionGenerator::operator()()
{
    msDescription.append('.');
    return msDescription.makeStringAndClear();
}

void DescriptionGenerator::AddProperty(const OUString& sPropertyName, PropertyType aType)
{
    uno::Reference<beans::XPropertyState> xState(mxShape, uno::UNO_QUERY);
    if (!xState.is()
        || xState->getPropertyState(sPropertyName) == beans::PropertyState_DEFAULT_VALUE)
        return;

    if (!mxSet.is())
        return;

    // Append a separator from previous Properties.
    if (!mbIsFirstProperty)
        msDescription.append(',');
    else
    {
        SolarMutexGuard aGuard;

        msDescription.append(' ');
        msDescription.append(SvxResId(RID_SVXSTR_A11Y_AND));
        msDescription.append(' ');
        mbIsFirstProperty = false;
    }

    // Delegate to type specific property handling.
    switch (aType)
    {
        case PropertyType::Color:
            AddColor(sPropertyName);
            break;
        case PropertyType::Integer:
            AddInteger(sPropertyName);
            break;
    }
}

void DescriptionGenerator::AppendString(std::u16string_view sString)
{
    msDescription.append(sString);
}

/** Search for the given color in the global color table.  If found append
    its name to the description.  Otherwise append its RGB tuple.
*/
void DescriptionGenerator::AddColor(const OUString& sPropertyName)
{
    msDescription.append('=');

    try
    {
        tools::Long nValue(0);
        if (mxSet.is())
        {
            uno::Any aValue = mxSet->getPropertyValue(sPropertyName);
            aValue >>= nValue;
        }

        msDescription.append(lookUpColorName(nValue));
    }
    catch (const css::beans::UnknownPropertyException&)
    {
        msDescription.append("<unknown>");
    }
}

void DescriptionGenerator::AddInteger(const OUString& sPropertyName)
{
    msDescription.append('=');

    try
    {
        if (mxSet.is())
        {
            uno::Any aValue = mxSet->getPropertyValue(sPropertyName);
            tools::Long nValue = 0;
            aValue >>= nValue;
            msDescription.append(nValue);
        }
    }
    catch (const css::beans::UnknownPropertyException&)
    {
        msDescription.append("<unknown>");
    }
}

} // end of namespace accessibility

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */