attributelist.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 .
 */

#ifndef INCLUDED_OOX_HELPER_ATTRIBUTELIST_HXX
#define INCLUDED_OOX_HELPER_ATTRIBUTELIST_HXX

#include <sal/config.h>

#include <string_view>
#include <vector>

#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/util/DateTime.hpp>
#include <oox/helper/helper.hxx>
#include <oox/dllapi.h>
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <oox/drawingml/color.hxx>

namespace com::sun::star {
    namespace xml::sax { class XFastAttributeList; }
}

namespace sax_fastparser {
    class FastAttributeList;
};

namespace oox {

    /* Get the color tokens from their string representatives. */
    sal_Int32 getHighlightColorTokenFromString(std::u16string_view sColorName);

class OOX_DLLPUBLIC AttributeConversion
{
public:
    static sal_Int32    decodeToken( std::u16string_view rValue );

    static OUString decodeXString( const OUString& rValue );

    static sal_Int32    decodeInteger( const OUString& rValue );

    static sal_uInt32   decodeUnsigned( const OUString& rValue );

    static sal_Int64    decodeHyper( const OUString& rValue );

    static sal_Int32    decodeIntegerHex( const OUString& rValue );
};


class OOX_DLLPUBLIC AttributeList
{
public:
    explicit            AttributeList(
                            const css::uno::Reference< css::xml::sax::XFastAttributeList >& rxAttribs );

    const css::uno::Reference< css::xml::sax::XFastAttributeList >&
                        getFastAttributeList() const { return mxAttribs; }

    bool                hasAttribute( sal_Int32 nAttrToken ) const;

    // optional return values -------------------------------------------------

    OptValue< sal_Int32 > getToken( sal_Int32 nAttrToken ) const;

    oox::drawingml::Color getHighlightColor(sal_Int32 nAttrToken) const;

    OptValue< OUString > getString( sal_Int32 nAttrToken ) const;

    OptValue< OUString > getXString( sal_Int32 nAttrToken ) const;

    OptValue< double >  getDouble( sal_Int32 nAttrToken ) const;

    OptValue< sal_Int32 > getInteger( sal_Int32 nAttrToken ) const;

    OptValue< sal_uInt32 > getUnsigned( sal_Int32 nAttrToken ) const;

    OptValue< sal_Int64 > getHyper( sal_Int32 nAttrToken ) const;

    OptValue< sal_Int32 > getIntegerHex( sal_Int32 nAttrToken ) const;

    OptValue< bool >    getBool( sal_Int32 nAttrToken ) const;

    OptValue< css::util::DateTime > getDateTime( sal_Int32 nAttrToken ) const;

    // defaulted return values ------------------------------------------------

    sal_Int32           getToken( sal_Int32 nAttrToken, sal_Int32 nDefault ) const;

    OUString     getString( sal_Int32 nAttrToken, const OUString& rDefault ) const;

    OUString     getXString( sal_Int32 nAttrToken, const OUString& rDefault ) const;

    const char* getChar( sal_Int32 nAttrToken ) const;


    double              getDouble( sal_Int32 nAttrToken, double fDefault ) const;

    sal_Int32           getInteger( sal_Int32 nAttrToken, sal_Int32 nDefault ) const;

    sal_uInt32          getUnsigned( sal_Int32 nAttrToken, sal_uInt32 nDefault ) const;

    sal_Int64           getHyper( sal_Int32 nAttrToken, sal_Int64 nDefault ) const;

    sal_Int32           getIntegerHex( sal_Int32 nAttrToken, sal_Int32 nDefault ) const;

    sal_uInt32          getUnsignedHex( sal_Int32 nAttrToken, sal_uInt32 nDefault ) const;

    bool                getBool( sal_Int32 nAttrToken, bool bDefault ) const;

    css::util::DateTime getDateTime( sal_Int32 nAttrToken, const css::util::DateTime& rDefault ) const;

    std::vector<sal_Int32> getTokenList(sal_Int32 nAttrToken) const;

private:
    css::uno::Reference< css::xml::sax::XFastAttributeList >
                        mxAttribs;
    mutable sax_fastparser::FastAttributeList *mpAttribList;
    sax_fastparser::FastAttributeList *getAttribList() const;
};


} // namespace oox

#endif

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