diff options
Diffstat (limited to 'offapi/com/sun/star/ucb/ContentProvider.idl')
-rw-r--r-- | offapi/com/sun/star/ucb/ContentProvider.idl | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/ContentProvider.idl b/offapi/com/sun/star/ucb/ContentProvider.idl new file mode 100644 index 000000000000..d5fe7874a8c1 --- /dev/null +++ b/offapi/com/sun/star/ucb/ContentProvider.idl @@ -0,0 +1,152 @@ +/************************************************************************* + * + * $RCSfile: ContentProvider.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:22:31 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 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 + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_ucb_ContentProvider_idl__ +#define __com_sun_star_ucb_ContentProvider_idl__ + +#ifndef __com_sun_star_ucb_XContentProvider_idl__ +#include <com/sun/star/ucb/XContentProvider.idl> +#endif + +#ifndef __com_sun_star_ucb_XContentIdentifierFactory_idl__ +#include <com/sun/star/ucb/XContentIdentifierFactory.idl> +#endif + +#ifndef __com_sun_star_ucb_XContentCreator_idl__ +#include <com/sun/star/ucb/XContentCreator.idl> +#endif + +#ifndef __com_sun_star_ucb_XParameterizedContentProvider_idl__ +#include <com/sun/star/ucb/XParameterizedContentProvider.idl> +#endif + +#ifndef __com_sun_star_ucb_XContentProviderSupplier_idl__ +#include <com/sun/star/ucb/XContentProviderSupplier.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ucb { + +//============================================================================= +/** A <type>ContentProvider</type> provides access to a set of contents. +*/ +service ContentProvider +{ + //------------------------------------------------------------------------- + /** gives access to all kind of contents provided by this provider. + */ + interface com::sun::star::ucb::XContentProvider; + + //------------------------------------------------------------------------- + /** creates special <type>XContentIdentifier</type> implementation + objects for the contents provided by this content provider. + + This interface is optional. It can be implemented in case the + provider wants to provide some additional interfaces with + it's implementation of the identifier objects. + */ + // [optional] + interface com::sun::star::ucb::XContentIdentifierFactory; + + //------------------------------------------------------------------------- + /** creates new root contents (i.e. a new POP3-Account object). A content + is "new", if it does not physically exist before creating it using + this interface. A root object is an object which is no child of + another content. + + This interface must be implemented only by providers which are able + to create new root objects. + */ + // [optional] + interface com::sun::star::ucb::XContentCreator; + + //------------------------------------------------------------------------- + /** allows a <type>ContentProvider</type> to adjust itself to special + needs. Whenever a <type>ContentProvider</type> that supports this + interface is registered at a <type>XContentProviderManager</type>, the + method + <method>XParameterizedContentProvider::registerInstance</method> + should first be called, using the returned + <type>XContentProvider</type> to register at the + <type>XContentProviderManager</type>. + */ + // [optional] + interface com::sun::star::ucb::XParameterizedContentProvider; + + //------------------------------------------------------------------------- + /** allows the implementation of a proxy object for a content provider. + The content provider returned by the implementation of this interface + will be the original provider. Implementing a content provider proxy + can be useful if the creation of the real content provider object + shall be deferred for some reason until the first method gets called + on it ( i.e. performance ). + + @see service <type>ContentProviderProxy</type> + */ + // [optional] + interface com::sun::star::ucb::XContentProviderSupplier; +}; + +//============================================================================= + +}; }; }; }; + +#endif |