include/cppuhelper/supportsservice.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
  10 /*
  11  * This file is part of LibreOffice published API.
  12  */
  13
  14 #ifndef INCLUDED_CPPUHELPER_SUPPORTSSERVICE_HXX
  15 #define INCLUDED_CPPUHELPER_SUPPORTSSERVICE_HXX
  16
  17 #include "sal/config.h"
  18
  19 #include "cppuhelper/cppuhelperdllapi.h"
  20
  21 namespace com { namespace sun { namespace star { namespace lang {
  22     class XServiceInfo;
  23 } } } }
  24 namespace rtl { class OUString; }
  25
  26 namespace cppu {
  27
  28 /** A helper for implementations of com.sun.star.lang.XServiceInfo.
  29
  30     This function is supposed to be called from implementations of
  31     css::lang::XServiceInfo::supportsService (and therefore, for
  32     easier coding takes the caller's this pointer by pointer rather than by
  33     css::uno::Reference).
  34
  35     @param implementation points to the service implementation whose
  36     getSupportedServices method is consulted; must be non-null
  37
  38     @param name the service name to test
  39
  40     @return true iff the sequence returned by the given implementation's
  41     getSupportedServices method contains the given name
  42
  43     @since LibreOffice 4.0
  44 */
  45 bool CPPUHELPER_DLLPUBLIC supportsService(
  46     css::lang::XServiceInfo * implementation,
  47     rtl::OUString const & name);
  48
  49 }
  50
  51 #endif
  52
  53 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */