offapi/com/sun/star/ucb/XContentAccess.idl

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