office-gobmx/include/cppuhelper/component.hxx
Norbert Thiebaud 2f3305e939 fdo#65108 inter-module includes <> include/cppuhelper
Change-Id: Ife81bf3dacb574b664982f3b4d2c7af9eb78a66a
2013-11-09 18:48:40 -06:00

113 lines
4.2 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 INCLUDED_CPPUHELPER_COMPONENT_HXX
#define INCLUDED_CPPUHELPER_COMPONENT_HXX
#include <osl/mutex.hxx>
#include <cppuhelper/weakagg.hxx>
#include <cppuhelper/interfacecontainer.hxx>
#include <cppuhelper/implbase1.hxx>
#include <com/sun/star/lang/XComponent.hpp>
#include <com/sun/star/lang/XEventListener.hpp>
#include <cppuhelper/cppuhelperdllapi.h>
namespace cppu
{
/** Deprecated. Helper for implementing com::sun::star::lang::XComponent.
Upon disposing objects of this class, sub-classes receive a disposing() call. Objects of
this class can be held weakly, i.e. by a com::sun::star::uno::WeakReference. Object of
this class can be aggregated, i.e. incoming queryInterface() calls are delegated.
@attention
The life-cycle of the passed mutex reference has to be longer than objects of this class.
@deprecated
*/
class CPPUHELPER_DLLPUBLIC OComponentHelper
: public ::cppu::OWeakAggObject
, public ::com::sun::star::lang::XTypeProvider
, public ::com::sun::star::lang::XComponent
{
public:
/** Constructor.
@param rMutex
the mutex used to protect multi-threaded access;
lifetime must be longer than the lifetime of this object.
*/
OComponentHelper( ::osl::Mutex & rMutex ) SAL_THROW(());
/** Destructor. If this object was not disposed previously, object will be disposed manually.
*/
virtual ~OComponentHelper() SAL_THROW( (::com::sun::star::uno::RuntimeException) );
// XAggregation
virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
::com::sun::star::uno::Type const & rType )
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation(
::com::sun::star::uno::Type const & rType )
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL acquire()
throw ();
virtual void SAL_CALL release()
throw ();
/** @attention
XTypeProvider::getImplementationId() has to be implemented separately!
*/
virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId()
throw(::com::sun::star::uno::RuntimeException) = 0;
/** @attention
XTypeProvider::getTypes() has to be re-implemented!
*/
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes()
throw (::com::sun::star::uno::RuntimeException);
// XComponent
virtual void SAL_CALL dispose()
throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL addEventListener(
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener )
throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeEventListener(
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener )
throw(::com::sun::star::uno::RuntimeException);
protected:
/** Called in dispose method after the listeners were notified.
*/
virtual void SAL_CALL disposing();
/// @cond INTERNAL
OBroadcastHelper rBHelper;
/// @endcond
private:
inline OComponentHelper( const OComponentHelper & ) SAL_THROW(());
inline OComponentHelper & operator = ( const OComponentHelper & ) SAL_THROW(());
};
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */