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 INCLUDED_COMPHELPER_SERVICEINFOHELPER_HXX
  21 #define INCLUDED_COMPHELPER_SERVICEINFOHELPER_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <initializer_list>
  26
  27 #include <com/sun/star/lang/XServiceInfo.hpp>
  28 #include <comphelper/comphelperdllapi.h>
  29
  30 namespace comphelper {
  31
  32 /** this class provides a basic helper for classes supporting the XServiceInfo Interface.
  33  *
  34  *  you can override the <code>getSupprotedServiceNames</code> to implement a XServiceInfo.
  35  *  you can use the static helper methods to combine your services with that of parent
  36  *  or aggregated classes.
  37  */
  38 class COMPHELPER_DLLPUBLIC ServiceInfoHelper : public css::lang::XServiceInfo
  39 {
  40 public:
  41     // XServiceInfo
  42     virtual OUString SAL_CALL getImplementationName() throw(css::uno::RuntimeException, std::exception) override;
  43     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() throw(css::uno::RuntimeException, std::exception) override;
  44
  45     // helper
  46     static void addToSequence( css::uno::Sequence< OUString >& rSeq, std::initializer_list<OUString> services ) throw();
  47
  48 protected:
  49     ~ServiceInfoHelper() {}
  50 };
  51
  52 }
  53
  54 #endif
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */