xref: /trunk/main/offapi/com/sun/star/ucb/XContent.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_ucb_XContent_idl__
#define __com_sun_star_ucb_XContent_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_ucb_XContentIdentifier_idl__
#include <com/sun/star/ucb/XContentIdentifier.idl>
#endif

#ifndef __com_sun_star_ucb_XContentEventListener_idl__
#include <com/sun/star/ucb/XContentEventListener.idl>
#endif


//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** specifies a content with a type and an identifier, which is able to manage
    listeners for events that are related to contents.

     @version  1.0
     @author   Kai Sommerfeld
     @see      XContentIdentifier
     @see      XContentEventListener
*/
published interface XContent: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** returns the identifier of the content.

        @returns
        the identifier.
    */
    com::sun::star::ucb::XContentIdentifier getIdentifier();

    //-------------------------------------------------------------------------
    /** returns a type string, which is unique for that type of content (e.g.
        "application/vnd.sun.star.hierarchy-folder").

        @returns
        the content type string.
    */
    string getContentType();

    //-------------------------------------------------------------------------
    /** adds a listener for content events.

        @param Listener
        the listener to add.

        @see ContentEvent
    */
    [oneway] void addContentEventListener(
                    [in] com::sun::star::ucb::XContentEventListener Listener );

    //-------------------------------------------------------------------------
    /** removes a listener for content events.

        @param Listener
        the listener to remove.

        @see ContentEvent
    */
    [oneway] void removeContentEventListener(
                    [in] com::sun::star::ucb::XContentEventListener Listener );

};

//=============================================================================

}; }; }; };

#endif