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