office-gobmx/include/vbahelper/vbahelperinterface.hxx
Bjoern Michaelsen b9337e22ce execute move of global headers
see https://gerrit.libreoffice.org/#/c/3367/
and Change-Id: I00c96fa77d04b33a6f8c8cd3490dfcd9bdc9e84a for details

Change-Id: I199a75bc4042af20817265d5ef85b1134a96ff5a
2013-04-23 22:20:31 +02:00

185 lines
8.3 KiB
C++

/* -*- 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 OOVBAAPI_VBA_HELPERINTERFACE_HXX
#define OOVBAAPI_VBA_HELPERINTERFACE_HXX
#include <cppuhelper/implbase1.hxx>
#include <cppuhelper/implbase2.hxx>
#include <cppuhelper/implbase3.hxx>
#include <ooo/vba/XHelperInterface.hpp>
#include <vbahelper/vbahelper.hxx>
#include <com/sun/star/container/XNameAccess.hpp>
// use this class when you have an a object like
// interface XAnInterface which contains XHelperInterface in its inheritance hierarchy
// interface XAnInterface
// {
// interface XHelperInterface;
// [attribute, string] name;
// }
// or
// interface XAnInterface : XHelperInterface;
// {
// [attribute, string] name;
// }
//
// then this class can provide a default implementation of XHelperInterface,
// you can use it like this
// typedef InheritedHelperInterfaceImpl< XAnInterface > > AnInterfaceImpl_BASE;
// class AnInterfaceImpl : public AnInterfaceImpl_BASE
// {
// public:
// AnInterface( const Reference< HelperInterface >& xParent ) : AnInterfaceImpl_BASE( xParent ) {}
// // implement XAnInterface methods only, no need to implement the XHelperInterface
// // methods
// virtual void setName( const OUString& );
// virtual OUString getName();
// }
//
template< typename Ifc1 >
class SAL_DLLPUBLIC_TEMPLATE InheritedHelperInterfaceImpl : public Ifc1
{
protected:
css::uno::WeakReference< ov::XHelperInterface > mxParent;
css::uno::Reference< css::uno::XComponentContext > mxContext;
public:
InheritedHelperInterfaceImpl() {}
InheritedHelperInterfaceImpl( const css::uno::Reference< css::uno::XComponentContext >& xContext ) : mxContext( xContext ) {}
InheritedHelperInterfaceImpl( const css::uno::Reference< ov::XHelperInterface >& xParent, const css::uno::Reference< css::uno::XComponentContext >& xContext ) : mxParent( xParent ), mxContext( xContext ) {}
virtual OUString getServiceImplName() = 0;
virtual css::uno::Sequence<OUString> getServiceNames() = 0;
// XHelperInterface Methods
virtual ::sal_Int32 SAL_CALL getCreator() throw (css::script::BasicErrorException, css::uno::RuntimeException)
{
return 0x53756E4F;
}
virtual css::uno::Reference< ov::XHelperInterface > SAL_CALL getParent( ) throw (css::script::BasicErrorException, css::uno::RuntimeException) { return mxParent; }
virtual css::uno::Any SAL_CALL Application( ) throw (css::script::BasicErrorException, css::uno::RuntimeException) {
// The application could certainly be passed around in the context - seems
// to make sense
css::uno::Reference< css::container::XNameAccess > xNameAccess( mxContext, css::uno::UNO_QUERY_THROW );
return xNameAccess->getByName( "Application" );
}
// XServiceInfo Methods
virtual OUString SAL_CALL getImplementationName( ) throw (css::uno::RuntimeException) { return getServiceImplName(); }
virtual ::sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) throw (css::uno::RuntimeException)
{
css::uno::Sequence< OUString > sServices = getSupportedServiceNames();
const OUString* pStart = sServices.getConstArray();
const OUString* pEnd = pStart + sServices.getLength();
for ( ; pStart != pEnd ; ++pStart )
if ( (*pStart).equals( ServiceName ) )
return sal_True;
return sal_False;
}
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames( ) throw (css::uno::RuntimeException)
{
css::uno::Sequence< OUString > aNames = getServiceNames();
return aNames;
}
};
template< typename Ifc1 >
class SAL_DLLPUBLIC_TEMPLATE InheritedHelperInterfaceImpl1 : public InheritedHelperInterfaceImpl< ::cppu::WeakImplHelper1< Ifc1 > >
{
typedef InheritedHelperInterfaceImpl< ::cppu::WeakImplHelper1< Ifc1 > > Base;
public:
InheritedHelperInterfaceImpl1< Ifc1 >() {}
InheritedHelperInterfaceImpl1< Ifc1 >( const css::uno::Reference< css::uno::XComponentContext >& xContext ) : Base( xContext ) {}
InheritedHelperInterfaceImpl1< Ifc1 >( const css::uno::Reference< ov::XHelperInterface >& xParent, const css::uno::Reference< css::uno::XComponentContext >& xContext ) : Base( xParent, xContext ) {}
};
template< typename Ifc1, typename Ifc2 >
class SAL_DLLPUBLIC_TEMPLATE InheritedHelperInterfaceImpl2 : public InheritedHelperInterfaceImpl< ::cppu::WeakImplHelper2< Ifc1, Ifc2 > >
{
typedef InheritedHelperInterfaceImpl< ::cppu::WeakImplHelper2< Ifc1, Ifc2 > > Base;
public:
InheritedHelperInterfaceImpl2< Ifc1, Ifc2 >() {}
InheritedHelperInterfaceImpl2< Ifc1, Ifc2 >( const css::uno::Reference< css::uno::XComponentContext >& xContext ) : Base( xContext ) {}
InheritedHelperInterfaceImpl2< Ifc1, Ifc2 >( const css::uno::Reference< ov::XHelperInterface >& xParent, const css::uno::Reference< css::uno::XComponentContext >& xContext ) : Base( xParent, xContext ) {}
};
template< typename Ifc1, typename Ifc2, typename Ifc3 >
class SAL_DLLPUBLIC_TEMPLATE InheritedHelperInterfaceImpl3 : public InheritedHelperInterfaceImpl< ::cppu::WeakImplHelper3< Ifc1, Ifc2, Ifc3 > >
{
typedef InheritedHelperInterfaceImpl< ::cppu::WeakImplHelper3< Ifc1, Ifc2, Ifc3 > > Base;
public:
InheritedHelperInterfaceImpl3< Ifc1, Ifc2, Ifc3 >() {}
InheritedHelperInterfaceImpl3< Ifc1, Ifc2, Ifc3 >( const css::uno::Reference< css::uno::XComponentContext >& xContext ) : Base( xContext ) {}
InheritedHelperInterfaceImpl3< Ifc1, Ifc2, Ifc3 >( const css::uno::Reference< ov::XHelperInterface >& xParent, const css::uno::Reference< css::uno::XComponentContext >& xContext ) : Base( xParent, xContext ) {}
};
// ============================================================================
/** Helper macro to implement the method 'getServiceImplName()' of the
'ooo.vba.XHelperInterface' interface. Will return the class name as service
implementation name.
*/
#define VBAHELPER_IMPL_GETSERVICEIMPLNAME( classname ) \
OUString classname::getServiceImplName() \
{ \
return OUString( #classname ); \
}
// ----------------------------------------------------------------------------
/** Helper macro to implement the method 'getServiceNames()' for a single
service name.
*/
#define VBAHELPER_IMPL_GETSERVICENAMES( classname, servicename ) \
css::uno::Sequence< OUString > classname::getServiceNames() \
{ \
static css::uno::Sequence< OUString > saServiceNames; \
if( saServiceNames.getLength() == 0 ) \
{ \
saServiceNames.realloc( 1 ); \
saServiceNames[ 0 ] = servicename; \
} \
return saServiceNames; \
}
// ----------------------------------------------------------------------------
/** Helper macro to declare the methods 'getServiceImplName()' and
'getServiceNames()' of the 'ooo.vba.XHelperInterface' interface in a class
declaration.
*/
#define VBAHELPER_DECL_XHELPERINTERFACE \
virtual OUString getServiceImplName(); \
virtual css::uno::Sequence< OUString > getServiceNames();
// ----------------------------------------------------------------------------
/** Helper macro to implement the methods 'getServiceImplName()' and
'getServiceNames()' of the 'ooo.vba.XHelperInterface' interface. Will
return the class name as service implementation name.
*/
#define VBAHELPER_IMPL_XHELPERINTERFACE( classname, servicename ) \
VBAHELPER_IMPL_GETSERVICEIMPLNAME( classname ) \
VBAHELPER_IMPL_GETSERVICENAMES( classname, servicename )
// ============================================================================
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */