Kaydet (Commit) e2ef2699 authored tarafından Stephan Bergmann's avatar Stephan Bergmann

Fold PropertySetHelper into its only use, Frame

Change-Id: I148e15c2c91a985cd110f5589adbf26c102b1cfb
üst d6d86237
...@@ -52,7 +52,6 @@ $(eval $(call gb_Library_use_libraries,fwi,\ ...@@ -52,7 +52,6 @@ $(eval $(call gb_Library_use_libraries,fwi,\
$(eval $(call gb_Library_add_exception_objects,fwi,\ $(eval $(call gb_Library_add_exception_objects,fwi,\
framework/source/fwi/classes/converter \ framework/source/fwi/classes/converter \
framework/source/fwi/classes/propertysethelper \
framework/source/fwi/classes/protocolhandlercache \ framework/source/fwi/classes/protocolhandlercache \
framework/source/fwi/helper/mischelper \ framework/source/fwi/helper/mischelper \
framework/source/fwi/helper/networkdomain \ framework/source/fwi/helper/networkdomain \
......
/* -*- 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_FRAMEWORK_INC_CLASSES_PROPERTYSETHELPER_HXX
#define INCLUDED_FRAMEWORK_INC_CLASSES_PROPERTYSETHELPER_HXX
#include <threadhelp/transactionbase.hxx>
#include <general.h>
#include <stdtypes.h>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/beans/XPropertySetInfo.hpp>
#include <com/sun/star/beans/PropertyExistException.hpp>
#include <com/sun/star/beans/UnknownPropertyException.hpp>
#include <cppuhelper/weakref.hxx>
#include <fwidllapi.h>
namespace framework{
/** supports the API XPropertySet and XPropertySetInfo.
*
* It must be used as baseclass. The internal list of supported
* properties can be changed every time so dynamic property set's
* can be implemented.
*
* Further the derived and this base class share the same lock.
* So it's possible to be threadsafe if it's needed.
*/
class FWI_DLLPUBLIC PropertySetHelper : public css::beans::XPropertySet
, public css::beans::XPropertySetInfo
{
/* types */
protected:
typedef BaseHash< css::beans::Property > TPropInfoHash;
/* member */
protected:
PropertySetHelper::TPropInfoHash m_lProps;
ListenerHash m_lSimpleChangeListener;
ListenerHash m_lVetoChangeListener;
// hold it weak ... otherwise this helper has to be "killed" explicitly .-)
css::uno::WeakReference< css::uno::XInterface > m_xBroadcaster;
TransactionManager& m_rTransactionManager;
/* native interface */
public:
/** initialize new instance of this helper.
*
* @param pExternalTransactionManager
* this helper must be used as a baseclass ...
* but then it should synchronize its own calls
* with the same transaction manager then it's superclass.
*/
PropertySetHelper( osl::Mutex & mutex,
TransactionManager* pExternalTransactionManager);
/** free all needed memory.
*/
virtual ~PropertySetHelper();
/** set a new owner for this helper.
*
* This owner is used as source for all broadcasted events.
* Further we hold it weak, because we don't wish to be disposed() .-)
*/
void impl_setPropertyChangeBroadcaster(const css::uno::Reference< css::uno::XInterface >& xBroadcaster);
/** add a new property info to the set of supported ones.
*
* @param aProperty
* describes the new property.
*
* @throw [css::beans::PropertyExistException]
* if a property with the same name already exists.
*
* Note: The consistence of the whole set of properties is not checked here.
* Means e.g. ... a handle which exists more than once is not detected.
* The owner of this class has to be sure, that every new property does
* not clash with any existing one.
*/
void SAL_CALL impl_addPropertyInfo(const css::beans::Property& aProperty)
throw(css::beans::PropertyExistException,
css::uno::Exception );
/** mark the object as "useable for working" or "dead".
*
* This correspond to the lifetime handling implemented by the base class TransactionBase.
* There is no chance to reactive a "dead" object by calling impl_enablePropertySet()
* again!
*/
void SAL_CALL impl_disablePropertySet();
/**
*/
virtual void SAL_CALL impl_setPropertyValue(const OUString& sProperty,
sal_Int32 nHandle ,
const css::uno::Any& aValue ) = 0;
virtual css::uno::Any SAL_CALL impl_getPropertyValue(const OUString& sProperty,
sal_Int32 nHandle ) = 0;
/* uno interface */
public:
// XPropertySet
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo()
throw(css::uno::RuntimeException, std::exception) override;
virtual void SAL_CALL setPropertyValue(const OUString& sProperty,
const css::uno::Any& aValue )
throw(css::beans::UnknownPropertyException,
css::beans::PropertyVetoException ,
css::lang::IllegalArgumentException ,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) override;
virtual css::uno::Any SAL_CALL getPropertyValue(const OUString& sProperty)
throw(css::beans::UnknownPropertyException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) override;
virtual void SAL_CALL addPropertyChangeListener(const OUString& sProperty,
const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener)
throw(css::beans::UnknownPropertyException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) override;
virtual void SAL_CALL removePropertyChangeListener(const OUString& sProperty,
const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener)
throw(css::beans::UnknownPropertyException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) override;
virtual void SAL_CALL addVetoableChangeListener(const OUString& sProperty,
const css::uno::Reference< css::beans::XVetoableChangeListener >& xListener)
throw(css::beans::UnknownPropertyException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) override;
virtual void SAL_CALL removeVetoableChangeListener(const OUString& sProperty,
const css::uno::Reference< css::beans::XVetoableChangeListener >& xListener)
throw(css::beans::UnknownPropertyException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) override;
// XPropertySetInfo
virtual css::uno::Sequence< css::beans::Property > SAL_CALL getProperties()
throw(css::uno::RuntimeException, std::exception) override;
virtual css::beans::Property SAL_CALL getPropertyByName(const OUString& sName)
throw(css::beans::UnknownPropertyException,
css::uno::RuntimeException, std::exception ) override;
virtual sal_Bool SAL_CALL hasPropertyByName(const OUString& sName)
throw(css::uno::RuntimeException, std::exception) override;
/* internal helper */
private:
bool impl_existsVeto(const css::beans::PropertyChangeEvent& aEvent);
void impl_notifyChangeListener(const css::beans::PropertyChangeEvent& aEvent);
};
} // namespace framework
#endif // INCLUDED_FRAMEWORK_INC_CLASSES_PROPERTYSETHELPER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment