propertystatecontainer.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_COMPHELPER_PROPERTYSTATECONTAINER_HXX
#define INCLUDED_COMPHELPER_PROPERTYSTATECONTAINER_HXX
 
#include <comphelper/propertycontainer.hxx>
#include <com/sun/star/beans/XPropertyState.hpp>
#include <cppuhelper/implbase1.hxx>
#include <comphelper/uno3.hxx>
#include <comphelper/comphelperdllapi.h>
 
 
namespace comphelper
{
 
 
    //= OPropertyStateContainer
 
    typedef ::cppu::ImplHelper1 <   css::beans::XPropertyState
                                >   OPropertyStateContainer_TBase;
 
    class COMPHELPER_DLLPUBLIC OPropertyStateContainer
                :public  OPropertyContainer
                ,public  OPropertyStateContainer_TBase
    {
    protected:
        OPropertyStateContainer( ::cppu::OBroadcastHelper&  _rBHelper );
 
 
        // XPropertyState
        virtual css::beans::PropertyState SAL_CALL getPropertyState( const OUString& PropertyName ) override;
        virtual css::uno::Sequence< css::beans::PropertyState > SAL_CALL getPropertyStates( const css::uno::Sequence< OUString >& aPropertyName ) override;
        virtual void SAL_CALL setPropertyToDefault( const OUString& PropertyName ) override;
        virtual css::uno::Any SAL_CALL getPropertyDefault( const OUString& aPropertyName ) override;
 
 
        // own overridables
        // these are the impl-methods for the XPropertyState members - they are implemented already by this class,
        // but you may want to override them for whatever reasons (for instance, if your derived class
        // supports the AMBIGUOUS state for properties)
 
        css::beans::PropertyState  getPropertyStateByHandle( sal_Int32 _nHandle ) const;
 
        void                       setPropertyToDefaultByHandle( sal_Int32 _nHandle );
 
        virtual void getPropertyDefaultByHandle( sal_Int32 _nHandle, css::uno::Any& _rDefault ) const = 0;
 
    protected:
        // XInterface
        virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& _rType ) override;
        // XTypeProvider
        DECLARE_XTYPEPROVIDER( )
 
    protected:
        sal_Int32   getHandleForName( const OUString& _rPropertyName );
    };
 
 
}   // namespace comphelper
 
 
#endif // INCLUDED_COMPHELPER_PROPERTYSTATECONTAINER_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */