/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: HelpContent.idl,v $
*
* $Revision: 1.5 $
*
* last change: $Author: rt $ $Date: 2005-09-08 07:29:12 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef __com_sun_star_ucb_HelpContent_idl__
#define __com_sun_star_ucb_HelpContent_idl__
#ifndef __com_sun_star_lang_XComponent_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XContent_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XCommandProcessor2_idl__
#include
#endif
#ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
#include
#endif
#ifndef __com_sun_star_beans_XPropertyContainer_idl__
#include
#endif
#ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
#include
#endif
#ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
#include
#endif
#ifndef __com_sun_star_container_XChild_idl__
#include
#endif
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** A Help Content represents either a directory object allowing access to a
search engine and to index information for the respective module, or an
object allowing access to the concrete written help content.
@see com::sun::star::ucb::HelpContentProvider
*/
published service HelpContent
{
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::lang::XComponent;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::ucb::XContent;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
Supported Commands
-
getCommandInfo
-
getPropertySetInfo
-
getPropertyValues
-
setPropertyValues
-
open
Supported Properties
-
string ContentType ( read-only,
""application/vnd.sun.star.help" )
-
boolean IsReadOnly ( read-only, always "true" )
-
boolean IsDocument ( read-only )
-
boolean IsFolder ( read-only )
-
string Title ( read-only, content title )
-
string MediaType ( read only, either "image/gif", "text/plain",
"text/html" or "text/css" )
-
sequence<string> KeywordList ( read-only, only if IsFolder is true,
contains the index )
-
sequence<sequence<string>> KeywordRef ( read-only, only if IsFolder is true,
contains the links belonging to the index )
-
sequence<sequence<string>> KeywordAnchorForRef ( read-only, only if IsFolder is true,
contains the anchor names belonging to the index )
-
sequence<sequence<string>> KeywordTitleForRef ( read-only, , only if IsFolder is true,
contains the titles of the documents in which the keywords are found. )
-
sequence<string> SearchScopes ( read only, , only if IsFolder is true,
contains the scopes in which to search ).
-
string AnchorName ( readonly, only if content is has media type "text/html".
*/
interface com::sun::star::ucb::XCommandProcessor;
//-------------------------------------------------------------------------
/** is an enhanced version of XCommandProcessor that has an
additional method for releasing command identifiers obtained via
XCommandProcessor::createCommandIdentifier to avoid
resource leaks. For a detailed description of the problem refer to
XCommandProcessor2::releaseCommandIdentifier.
Where many existing Content implementations do not
(yet), every new implementation should support this interface.
*/
[optional] interface com::sun::star::ucb::XCommandProcessor2;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::beans::XPropertiesChangeNotifier;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::beans::XPropertyContainer;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::ucb::XCommandInfoChangeNotifier;
//-------------------------------------------------------------------------
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::container::XChild;
};
//=============================================================================
}; }; }; };
#endif