summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/XContentAccess.idl
blob: 7cf49059bfc1e4eb5dbc260b83681ef943a2f81a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/*************************************************************************
 *
 *  $RCSfile: XContentAccess.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 13:18:10 $
 *
 *  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_XContentAccess_idl__
#define __com_sun_star_ucb_XContentAccess_idl__

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

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

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

interface XContent;
interface XContentIdentifier;

//=============================================================================
/** specifies methods for obtaining information on a content in different
    levels. In example, if there is a cursor which points to
    <type>XContent</type>'s, this interface could be used to give the user
    access to the content under the cursor. If the client only needs the
    identifier string of the content, there is no need to first create the
    content object, then to obtain the string from it and after that to
    release the content.

    @version    1.0
    @author     Kai Sommerfeld
    @see        XContent
    @see        XContentIdentifier
*/

[ uik(6B13BAA0-FFD5-11d3-9F960050-04526AC8), ident( "XContentAccess", 1.0 ) ]
interface XContentAccess : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** returns the identifier string of the content ( "cheap method" ).
        Note that this string can be used later to recreate the content.

        @returns
        the identifier string.
    */
    string             queryContentIdentifierString();

    //-------------------------------------------------------------------------
    /** returns the identifier object of the content.

        @returns
        the identifier object.
    */
    XContentIdentifier queryContentIdentifier();

    //-------------------------------------------------------------------------
    /** returns the content ( "most expensive method" ).

        @returns
        the content.
    */
    XContent           queryContent();
};

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

}; }; }; };

#endif