offapi/com/sun/star/ucb/HelpContentProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ucb_HelpContentProvider_idl__
  28 #define __com_sun_star_ucb_HelpContentProvider_idl__
  29
  30 #ifndef __com_sun_star_ucb_XContentProvider_idl__
  31 #include <com/sun/star/ucb/XContentProvider.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module ucb {
  38
  39 //=============================================================================
  40 /** The Help Content Provider (HCP) implements a <type>ContentProvider</type>
  41     for the <Type>UniversalContentBroker</type> (UCB).
  42
  43     <p>The served contents enable access to the help contents and to the
  44     search engine.
  45
  46     @see com::sun::star::ucb::Content
  47 */
  48
  49 published service HelpContentProvider
  50 {
  51     //-------------------------------------------------------------------------
  52     /** provides an object representing either a directory object allowing
  53         searching or a help content object providing access to the help content.
  54
  55         @see com::sun::star::ucb::HelpContent
  56      */
  57
  58     interface com::sun::star::ucb::XContentProvider;
  59
  60 };
  61
  62 //=============================================================================
  63
  64 }; }; }; };
  65
  66 #endif