propertyset.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_PROPERTYSET_HXX
#define INCLUDED_OOX_HELPER_PROPERTYSET_HXX

#include <com/sun/star/uno/Any.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <oox/dllapi.h>
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <tools/color.hxx>

namespace com::sun::star {
    namespace beans { class XMultiPropertySet; }
    namespace beans { class XPropertySet; }
    namespace beans { class XPropertySetInfo; }
}

namespace oox {

class PropertyMap;


class OOX_DLLPUBLIC PropertySet
{
public:
    PropertySet() {}

    explicit     PropertySet(
                            const css::uno::Reference< css::beans::XPropertySet >& rxPropSet )
                                { set( rxPropSet ); }

    template< typename Type >
    explicit     PropertySet( const Type& rObject ) { set( rObject ); }

    void                set( const css::uno::Reference< css::beans::XPropertySet >& rxPropSet );

    template< typename Type >
    void         set( const Type& rObject )
                            { set( css::uno::Reference< css::beans::XPropertySet >( rObject, css::uno::UNO_QUERY ) ); }

    bool         is() const { return mxPropSet.is(); }

    bool                hasProperty( sal_Int32 nPropId ) const;

    // Get properties ---------------------------------------------------------

    css::uno::Any getAnyProperty( sal_Int32 nPropId ) const;

    template< typename Type >
    bool         getProperty( Type& orValue, sal_Int32 nPropId ) const
                            { return getAnyProperty( nPropId ) >>= orValue; }

    bool         getBoolProperty( sal_Int32 nPropId ) const
                            { bool bValue = false; return getProperty( bValue, nPropId ) && bValue; }
    // Set properties ---------------------------------------------------------

    bool                setAnyProperty( sal_Int32 nPropId, const css::uno::Any& rValue );

    template< typename Type >
    bool         setProperty( sal_Int32 nPropId, const Type& rValue )
                            { return setAnyProperty( nPropId, css::uno::Any( rValue ) ); }
    bool         setProperty( sal_Int32 nPropId, ::Color rValue )
                            { return setAnyProperty( nPropId, css::uno::makeAny( rValue ) ); }

    void                setProperties(
                            const css::uno::Sequence< OUString >& rPropNames,
                            const css::uno::Sequence< css::uno::Any >& rValues );

    void                setProperties( const PropertyMap& rPropertyMap );

#ifdef DBG_UTIL
    void dump();
#endif


private:
    bool                implGetPropertyValue( css::uno::Any& orValue, const OUString& rPropName ) const;

    bool                implSetPropertyValue( const OUString& rPropName, const css::uno::Any& rValue );

private:
    css::uno::Reference< css::beans::XPropertySet >
                        mxPropSet;          
    css::uno::Reference< css::beans::XMultiPropertySet >
                        mxMultiPropSet;     
    css::uno::Reference< css::beans::XPropertySetInfo >
                        mxPropSetInfo;      
};


} // namespace oox

#endif

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