include/comphelper/serviceinfohelper.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef COMPHELPER_SERVICEINFOHELPER_HXX
  21 #define COMPHELPER_SERVICEINFOHELPER_HXX
  22
  23 #include <com/sun/star/lang/XServiceInfo.hpp>
  24 #include "comphelper/comphelperdllapi.h"
  25
  26 namespace comphelper {
  27
  28 /** this class provides a basic helper for classes suporting the XServiceInfo Interface.
  29  *
  30  *  you can overload the <code>getSupprotedServiceNames</code> to implement a XServiceInfo.
  31  *  you can use the static helper methods to combine your services with that of parent
  32  *  or aggregatet classes.
  33  */
  34 class COMPHELPER_DLLPUBLIC ServiceInfoHelper : public ::com::sun::star::lang::XServiceInfo
  35 {
  36 public:
  37     // XServiceInfo
  38     virtual OUString SAL_CALL getImplementationName() throw(::com::sun::star::uno::RuntimeException);
  39     virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) throw(::com::sun::star::uno::RuntimeException);
  40     virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() throw(::com::sun::star::uno::RuntimeException);
  41
  42     // helper
  43     static void addToSequence( ::com::sun::star::uno::Sequence< OUString >& rSeq, sal_uInt16 nServices, /* sal_Char* */... ) throw();
  44     static sal_Bool SAL_CALL supportsService( const OUString& ServiceName, const ::com::sun::star::uno::Sequence< OUString >& SupportedServices ) throw();
  45
  46 protected:
  47     ~ServiceInfoHelper() {}
  48 };
  49
  50 }
  51
  52 #endif
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */