xref: /aoo41x/main/offapi/com/sun/star/ucb/XContent.idl (revision cdf0e10c)
1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XContent_idl__
28*cdf0e10cSrcweir#define __com_sun_star_ucb_XContent_idl__
29*cdf0e10cSrcweir
30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
32*cdf0e10cSrcweir#endif
33*cdf0e10cSrcweir
34*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XContentIdentifier_idl__
35*cdf0e10cSrcweir#include <com/sun/star/ucb/XContentIdentifier.idl>
36*cdf0e10cSrcweir#endif
37*cdf0e10cSrcweir
38*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XContentEventListener_idl__
39*cdf0e10cSrcweir#include <com/sun/star/ucb/XContentEventListener.idl>
40*cdf0e10cSrcweir#endif
41*cdf0e10cSrcweir
42*cdf0e10cSrcweir
43*cdf0e10cSrcweir//=============================================================================
44*cdf0e10cSrcweir
45*cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
46*cdf0e10cSrcweir
47*cdf0e10cSrcweir//=============================================================================
48*cdf0e10cSrcweir/** specifies a content with a type and an identifier, which is able to manage
49*cdf0e10cSrcweir    listeners for events that are related to contents.
50*cdf0e10cSrcweir
51*cdf0e10cSrcweir     @version  1.0
52*cdf0e10cSrcweir     @author   Kai Sommerfeld
53*cdf0e10cSrcweir     @see      XContentIdentifier
54*cdf0e10cSrcweir	 @see      XContentEventListener
55*cdf0e10cSrcweir*/
56*cdf0e10cSrcweirpublished interface XContent: com::sun::star::uno::XInterface
57*cdf0e10cSrcweir{
58*cdf0e10cSrcweir	//-------------------------------------------------------------------------
59*cdf0e10cSrcweir	/** returns the identifier of the content.
60*cdf0e10cSrcweir
61*cdf0e10cSrcweir		@returns
62*cdf0e10cSrcweir		the identifier.
63*cdf0e10cSrcweir	*/
64*cdf0e10cSrcweir	com::sun::star::ucb::XContentIdentifier getIdentifier();
65*cdf0e10cSrcweir
66*cdf0e10cSrcweir	//-------------------------------------------------------------------------
67*cdf0e10cSrcweir    /** returns a type string, which is unique for that type of content	(e.g.
68*cdf0e10cSrcweir	    "application/vnd.sun.star.hierarchy-folder").
69*cdf0e10cSrcweir
70*cdf0e10cSrcweir        @returns
71*cdf0e10cSrcweir		the content type string.
72*cdf0e10cSrcweir	*/
73*cdf0e10cSrcweir	string getContentType();
74*cdf0e10cSrcweir
75*cdf0e10cSrcweir	//-------------------------------------------------------------------------
76*cdf0e10cSrcweir	/** adds a listener for content events.
77*cdf0e10cSrcweir
78*cdf0e10cSrcweir		@param Listener
79*cdf0e10cSrcweir		the listener to add.
80*cdf0e10cSrcweir
81*cdf0e10cSrcweir		@see ContentEvent
82*cdf0e10cSrcweir	*/
83*cdf0e10cSrcweir	[oneway] void addContentEventListener(
84*cdf0e10cSrcweir					[in] com::sun::star::ucb::XContentEventListener Listener );
85*cdf0e10cSrcweir
86*cdf0e10cSrcweir	//-------------------------------------------------------------------------
87*cdf0e10cSrcweir	/** removes a listener for content events.
88*cdf0e10cSrcweir
89*cdf0e10cSrcweir		@param Listener
90*cdf0e10cSrcweir		the listener to remove.
91*cdf0e10cSrcweir
92*cdf0e10cSrcweir		@see ContentEvent
93*cdf0e10cSrcweir	*/
94*cdf0e10cSrcweir	[oneway] void removeContentEventListener(
95*cdf0e10cSrcweir					[in] com::sun::star::ucb::XContentEventListener Listener );
96*cdf0e10cSrcweir
97*cdf0e10cSrcweir};
98*cdf0e10cSrcweir
99*cdf0e10cSrcweir//=============================================================================
100*cdf0e10cSrcweir
101*cdf0e10cSrcweir}; }; }; };
102*cdf0e10cSrcweir
103*cdf0e10cSrcweir#endif
104