1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_ucb_XContentAccess_idl__ 28#define __com_sun_star_ucb_XContentAccess_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34//============================================================================= 35 36module com { module sun { module star { module ucb { 37 38 published interface XContent; 39 published interface XContentIdentifier; 40 41//============================================================================= 42/** specifies methods for obtaining information on a content in different 43 levels. 44 45 <p>For example, if there is a cursor which points to <type>XContent</type>s, 46 this interface could be used to give the user access to the content under 47 the cursor. If the client only needs the identifier string of the content, 48 there is no need to first create the content object, then to obtain the 49 string from it and after that to release the content. 50 51 @version 1.0 52 @author Kai Sommerfeld 53 @see XContent 54 @see XContentIdentifier 55*/ 56 57published interface XContentAccess : com::sun::star::uno::XInterface 58{ 59 //------------------------------------------------------------------------- 60 /** returns the identifier string of the content ( "cheap method" ). 61 62 <p>Note that this string can be used later to recreate the content. 63 64 @returns 65 the identifier string. 66 */ 67 string queryContentIdentifierString(); 68 69 //------------------------------------------------------------------------- 70 /** returns the identifier object of the content. 71 72 @returns 73 the identifier object. 74 */ 75 XContentIdentifier queryContentIdentifier(); 76 77 //------------------------------------------------------------------------- 78 /** returns the content ( "most expensive method" ). 79 80 @returns 81 the content. 82 */ 83 XContent queryContent(); 84}; 85 86//============================================================================= 87 88}; }; }; }; 89 90#endif 91