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

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