xref: /aoo41x/main/sc/inc/miscuno.hxx (revision 38d50f7b)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef SC_MISCUNO_HXX
#define SC_MISCUNO_HXX

#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/container/XEnumerationAccess.hpp>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/container/XEnumeration.hpp>
#include <com/sun/star/container/XIndexAccess.hpp>
#include <cppuhelper/implbase2.hxx>
#include "scdllapi.h"

#define SC_SIMPLE_SERVICE_INFO( ClassName, ClassNameAscii, ServiceAscii )			 \
::rtl::OUString SAL_CALL ClassName::getImplementationName()						 \
	throw(::com::sun::star::uno::RuntimeException)									 \
{																					 \
	return ::rtl::OUString::createFromAscii(ClassNameAscii);						 \
}																					 \
sal_Bool SAL_CALL ClassName::supportsService( const ::rtl::OUString& ServiceName ) \
	throw(::com::sun::star::uno::RuntimeException)									 \
{																					 \
	return !ServiceName.compareToAscii(ServiceAscii);								 \
}																					 \
::com::sun::star::uno::Sequence< ::rtl::OUString >									 \
	SAL_CALL ClassName::getSupportedServiceNames(void)							 \
	throw(::com::sun::star::uno::RuntimeException)									 \
{																					 \
	::com::sun::star::uno::Sequence< ::rtl::OUString > aRet(1);						 \
	::rtl::OUString* pArray = aRet.getArray();										 \
	pArray[0] = ::rtl::OUString::createFromAscii(ServiceAscii);					 \
	return aRet;																	 \
}

#define SC_IMPL_DUMMY_PROPERTY_LISTENER( ClassName )								\
	void SAL_CALL ClassName::addPropertyChangeListener( const rtl::OUString&,		\
							const uno::Reference<beans::XPropertyChangeListener>&)	\
							throw(beans::UnknownPropertyException,					\
							lang::WrappedTargetException, uno::RuntimeException)	\
	{ DBG_ERROR("not implemented"); }												\
	void SAL_CALL ClassName::removePropertyChangeListener( const rtl::OUString&,	\
							const uno::Reference<beans::XPropertyChangeListener>&)	\
							throw(beans::UnknownPropertyException,					\
							lang::WrappedTargetException, uno::RuntimeException)	\
	{ DBG_ERROR("not implemented"); }												\
	void SAL_CALL ClassName::addVetoableChangeListener( const rtl::OUString&,		\
							const uno::Reference<beans::XVetoableChangeListener>&)	\
							throw(beans::UnknownPropertyException,					\
							lang::WrappedTargetException, uno::RuntimeException)	\
	{ DBG_ERROR("not implemented"); }												\
	void SAL_CALL ClassName::removeVetoableChangeListener( const rtl::OUString&,	\
							const uno::Reference<beans::XVetoableChangeListener>&)	\
							throw(beans::UnknownPropertyException,					\
							lang::WrappedTargetException, uno::RuntimeException)	\
	{ DBG_ERROR("not implemented"); }


#define SC_QUERYINTERFACE(x)	\
	if (rType == getCppuType((const uno::Reference<x>*)0))	\
    { return uno::makeAny(uno::Reference<x>(this)); }

// SC_QUERY_MULTIPLE( XElementAccess, XIndexAccess ):
//	use if interface is used several times in one class

#define SC_QUERY_MULTIPLE(x,y)	\
	if (rType == getCppuType((const uno::Reference<x>*)0))	\
	{ uno::Any aR; aR <<= uno::Reference<x>(static_cast<y*>(this)); return aR; }


class ScIndexEnumeration : public cppu::WeakImplHelper2<
								com::sun::star::container::XEnumeration,
								com::sun::star::lang::XServiceInfo >
{
private:
	com::sun::star::uno::Reference<com::sun::star::container::XIndexAccess> xIndex;
    rtl::OUString           sServiceName;
	sal_Int32				nPos;

public:
							ScIndexEnumeration(const com::sun::star::uno::Reference<
                                com::sun::star::container::XIndexAccess>& rInd, const rtl::OUString& rServiceName);
	virtual					~ScIndexEnumeration();

							// XEnumeration
	virtual sal_Bool SAL_CALL hasMoreElements() throw(::com::sun::star::uno::RuntimeException);
	virtual ::com::sun::star::uno::Any SAL_CALL nextElement()
								throw(::com::sun::star::container::NoSuchElementException,
										::com::sun::star::lang::WrappedTargetException,
										::com::sun::star::uno::RuntimeException);

							// XServiceInfo
	virtual ::rtl::OUString SAL_CALL getImplementationName(  )
								throw(::com::sun::star::uno::RuntimeException);
	virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName )
								throw(::com::sun::star::uno::RuntimeException);
	virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  )
								throw(::com::sun::star::uno::RuntimeException);
};

//UNUSED2008-05  class ScEmptyEnumerationAccess : public cppu::WeakImplHelper2<
//UNUSED2008-05                                  com::sun::star::container::XEnumerationAccess,
//UNUSED2008-05                                  com::sun::star::lang::XServiceInfo >
//UNUSED2008-05  {
//UNUSED2008-05  public:
//UNUSED2008-05                              ScEmptyEnumerationAccess();
//UNUSED2008-05      virtual                 ~ScEmptyEnumerationAccess();
//UNUSED2008-05
//UNUSED2008-05                              // XEnumerationAccess
//UNUSED2008-05      virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XEnumeration > SAL_CALL
//UNUSED2008-05                              createEnumeration() throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05
//UNUSED2008-05                              // XElementAccess
//UNUSED2008-05      virtual ::com::sun::star::uno::Type SAL_CALL getElementType()
//UNUSED2008-05                                  throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual sal_Bool SAL_CALL hasElements() throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05
//UNUSED2008-05                              // XServiceInfo
//UNUSED2008-05      virtual ::rtl::OUString SAL_CALL getImplementationName(  )
//UNUSED2008-05                                  throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName )
//UNUSED2008-05                                  throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  )
//UNUSED2008-05                                  throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05  };

//UNUSED2008-05  class ScEmptyEnumeration : public cppu::WeakImplHelper2<
//UNUSED2008-05                                  com::sun::star::container::XEnumeration,
//UNUSED2008-05                                  com::sun::star::lang::XServiceInfo >
//UNUSED2008-05  {
//UNUSED2008-05  public:
//UNUSED2008-05                              ScEmptyEnumeration();
//UNUSED2008-05      virtual                 ~ScEmptyEnumeration();
//UNUSED2008-05
//UNUSED2008-05                              // XEnumeration
//UNUSED2008-05      virtual sal_Bool SAL_CALL hasMoreElements() throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual ::com::sun::star::uno::Any SAL_CALL nextElement()
//UNUSED2008-05                                  throw(::com::sun::star::container::NoSuchElementException,
//UNUSED2008-05                                          ::com::sun::star::lang::WrappedTargetException,
//UNUSED2008-05                                          ::com::sun::star::uno::RuntimeException);
//UNUSED2008-05
//UNUSED2008-05                              // XServiceInfo
//UNUSED2008-05      virtual ::rtl::OUString SAL_CALL getImplementationName(  )
//UNUSED2008-05                                  throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName )
//UNUSED2008-05                                  throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  )
//UNUSED2008-05                                  throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05  };

//	new (uno 3) variant
class ScNameToIndexAccess : public cppu::WeakImplHelper2<
								com::sun::star::container::XIndexAccess,
								com::sun::star::lang::XServiceInfo >
{
private:
	com::sun::star::uno::Reference<com::sun::star::container::XNameAccess> xNameAccess;
	com::sun::star::uno::Sequence<rtl::OUString> aNames;

public:
							ScNameToIndexAccess(
								const com::sun::star::uno::Reference<
									com::sun::star::container::XNameAccess>& rNameObj );
	virtual					~ScNameToIndexAccess();

							// XIndexAccess
	virtual sal_Int32 SAL_CALL getCount(  ) throw(::com::sun::star::uno::RuntimeException);
	virtual ::com::sun::star::uno::Any SAL_CALL getByIndex( sal_Int32 Index )
								throw(::com::sun::star::lang::IndexOutOfBoundsException,
										::com::sun::star::lang::WrappedTargetException,
										::com::sun::star::uno::RuntimeException);

							// XElementAccess
	virtual ::com::sun::star::uno::Type SAL_CALL getElementType(  )
								throw(::com::sun::star::uno::RuntimeException);
	virtual sal_Bool SAL_CALL hasElements(  ) throw(::com::sun::star::uno::RuntimeException);

							// XServiceInfo
	virtual ::rtl::OUString SAL_CALL getImplementationName(  )
								throw(::com::sun::star::uno::RuntimeException);
	virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName )
								throw(::com::sun::star::uno::RuntimeException);
	virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  )
								throw(::com::sun::star::uno::RuntimeException);
};

//UNUSED2008-05  class ScPrintSettingsObj : public cppu::WeakImplHelper2<
//UNUSED2008-05                                  com::sun::star::beans::XPropertySet,
//UNUSED2008-05                                  com::sun::star::lang::XServiceInfo >
//UNUSED2008-05  {
//UNUSED2008-05  public:
//UNUSED2008-05                              ScPrintSettingsObj();
//UNUSED2008-05      virtual                 ~ScPrintSettingsObj();
//UNUSED2008-05
//UNUSED2008-05                              // XPropertySet
//UNUSED2008-05      virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo >
//UNUSED2008-05                              SAL_CALL getPropertySetInfo()
//UNUSED2008-05                                  throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual void SAL_CALL   setPropertyValue( const ::rtl::OUString& aPropertyName,
//UNUSED2008-05                                      const ::com::sun::star::uno::Any& aValue )
//UNUSED2008-05                                  throw(::com::sun::star::beans::UnknownPropertyException,
//UNUSED2008-05                                      ::com::sun::star::beans::PropertyVetoException,
//UNUSED2008-05                                      ::com::sun::star::lang::IllegalArgumentException,
//UNUSED2008-05                                      ::com::sun::star::lang::WrappedTargetException,
//UNUSED2008-05                                      ::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual ::com::sun::star::uno::Any SAL_CALL getPropertyValue(
//UNUSED2008-05                                      const ::rtl::OUString& PropertyName )
//UNUSED2008-05                                  throw(::com::sun::star::beans::UnknownPropertyException,
//UNUSED2008-05                                      ::com::sun::star::lang::WrappedTargetException,
//UNUSED2008-05                                      ::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual void SAL_CALL   addPropertyChangeListener( const ::rtl::OUString& aPropertyName,
//UNUSED2008-05                                      const ::com::sun::star::uno::Reference<
//UNUSED2008-05                                          ::com::sun::star::beans::XPropertyChangeListener >& xListener )
//UNUSED2008-05                                  throw(::com::sun::star::beans::UnknownPropertyException,
//UNUSED2008-05                                      ::com::sun::star::lang::WrappedTargetException,
//UNUSED2008-05                                      ::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual void SAL_CALL   removePropertyChangeListener( const ::rtl::OUString& aPropertyName,
//UNUSED2008-05                                      const ::com::sun::star::uno::Reference<
//UNUSED2008-05                                          ::com::sun::star::beans::XPropertyChangeListener >& aListener )
//UNUSED2008-05                                  throw(::com::sun::star::beans::UnknownPropertyException,
//UNUSED2008-05                                      ::com::sun::star::lang::WrappedTargetException,
//UNUSED2008-05                                      ::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual void SAL_CALL   addVetoableChangeListener( const ::rtl::OUString& PropertyName,
//UNUSED2008-05                                      const ::com::sun::star::uno::Reference<
//UNUSED2008-05                                          ::com::sun::star::beans::XVetoableChangeListener >& aListener )
//UNUSED2008-05                                  throw(::com::sun::star::beans::UnknownPropertyException,
//UNUSED2008-05                                      ::com::sun::star::lang::WrappedTargetException,
//UNUSED2008-05                                      ::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual void SAL_CALL   removeVetoableChangeListener( const ::rtl::OUString& PropertyName,
//UNUSED2008-05                                      const ::com::sun::star::uno::Reference<
//UNUSED2008-05                                          ::com::sun::star::beans::XVetoableChangeListener >& aListener )
//UNUSED2008-05                                  throw(::com::sun::star::beans::UnknownPropertyException,
//UNUSED2008-05                                      ::com::sun::star::lang::WrappedTargetException,
//UNUSED2008-05                                      ::com::sun::star::uno::RuntimeException);
//UNUSED2008-05
//UNUSED2008-05                              // XServiceInfo
//UNUSED2008-05      virtual ::rtl::OUString SAL_CALL getImplementationName(  )
//UNUSED2008-05                                  throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName )
//UNUSED2008-05                                  throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05      virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  )
//UNUSED2008-05                                  throw(::com::sun::star::uno::RuntimeException);
//UNUSED2008-05  };


class SC_DLLPUBLIC ScUnoHelpFunctions
{
public:
	static com::sun::star::uno::Reference<com::sun::star::uno::XInterface>
							AnyToInterface( const com::sun::star::uno::Any& rAny );
	static sal_Bool			GetBoolProperty( const com::sun::star::uno::Reference<
												com::sun::star::beans::XPropertySet>& xProp,
											const ::rtl::OUString& rName, sal_Bool bDefault = sal_False );
	static sal_Int32		GetLongProperty( const com::sun::star::uno::Reference<
												com::sun::star::beans::XPropertySet>& xProp,
											const ::rtl::OUString& rName, long nDefault = 0 );
	static sal_Int32		GetEnumProperty( const com::sun::star::uno::Reference<
												com::sun::star::beans::XPropertySet>& xProp,
											const ::rtl::OUString& rName, long nDefault );
    static ::rtl::OUString  GetStringProperty(
        const com::sun::star::uno::Reference<com::sun::star::beans::XPropertySet>& xProp,
        const ::rtl::OUString& rName, const ::rtl::OUString& rDefault );

	static sal_Bool			GetBoolFromAny( const com::sun::star::uno::Any& aAny );
	static sal_Int16		GetInt16FromAny( const com::sun::star::uno::Any& aAny );
	static sal_Int32		GetInt32FromAny( const com::sun::star::uno::Any& aAny );
	static sal_Int32		GetEnumFromAny( const com::sun::star::uno::Any& aAny );
	static void				SetBoolInAny( com::sun::star::uno::Any& rAny, sal_Bool bValue );

    static void             SetOptionalPropertyValue(
        ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& rPropSet,
        const sal_Char* pPropName, const ::com::sun::star::uno::Any& rVal );

    template<typename ValueType>
    static void             SetOptionalPropertyValue(
        ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& rPropSet,
        const sal_Char* pPropName, const ValueType& rVal )
    {
        ::com::sun::star::uno::Any any;
        any <<= rVal;
        SetOptionalPropertyValue(rPropSet, pPropName, any);
    }
};



#endif