xref: /AOO41X/main/offapi/com/sun/star/ucb/XContent.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_XContent_idl__
24#define __com_sun_star_ucb_XContent_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_ucb_XContentIdentifier_idl__
31#include <com/sun/star/ucb/XContentIdentifier.idl>
32#endif
33
34#ifndef __com_sun_star_ucb_XContentEventListener_idl__
35#include <com/sun/star/ucb/XContentEventListener.idl>
36#endif
37
38
39//=============================================================================
40
41module com { module sun { module star { module ucb {
42
43//=============================================================================
44/** specifies a content with a type and an identifier, which is able to manage
45    listeners for events that are related to contents.
46
47     @version  1.0
48     @author   Kai Sommerfeld
49     @see      XContentIdentifier
50     @see      XContentEventListener
51*/
52published interface XContent: com::sun::star::uno::XInterface
53{
54    //-------------------------------------------------------------------------
55    /** returns the identifier of the content.
56
57        @returns
58        the identifier.
59    */
60    com::sun::star::ucb::XContentIdentifier getIdentifier();
61
62    //-------------------------------------------------------------------------
63    /** returns a type string, which is unique for that type of content (e.g.
64        "application/vnd.sun.star.hierarchy-folder").
65
66        @returns
67        the content type string.
68    */
69    string getContentType();
70
71    //-------------------------------------------------------------------------
72    /** adds a listener for content events.
73
74        @param Listener
75        the listener to add.
76
77        @see ContentEvent
78    */
79    [oneway] void addContentEventListener(
80                    [in] com::sun::star::ucb::XContentEventListener Listener );
81
82    //-------------------------------------------------------------------------
83    /** removes a listener for content events.
84
85        @param Listener
86        the listener to remove.
87
88        @see ContentEvent
89    */
90    [oneway] void removeContentEventListener(
91                    [in] com::sun::star::ucb::XContentEventListener Listener );
92
93};
94
95//=============================================================================
96
97}; }; }; };
98
99#endif
100