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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_XContentAccess_idl__
  20 #define __com_sun_star_ucb_XContentAccess_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25 module com { module sun { module star { module ucb {
  26
  27  published interface XContent;
  28  published interface XContentIdentifier;
  29
  30 /** specifies methods for obtaining information on a content in different
  31     levels.
  32
  33     <p>For example, if there is a cursor which points to XContents,
  34     this interface could be used to give the user access to the content under
  35     the cursor. If the client only needs the identifier string of the content,
  36     there is no need to first create the content object, then to obtain the
  37     string from it and after that to release the content.
  38
  39     @version    1.0
  40     @author     Kai Sommerfeld
  41     @see        XContent
  42     @see        XContentIdentifier
  43 */
  44
  45 published interface XContentAccess : com::sun::star::uno::XInterface
  46 {
  47     /** returns the identifier string of the content ( "cheap method" ).
  48
  49         <p>Note that this string can be used later to recreate the content.
  50
  51         @returns
  52         the identifier string.
  53     */
  54     string queryContentIdentifierString();
  55
  56     /** returns the identifier object of the content.
  57
  58         @returns
  59         the identifier object.
  60     */
  61     XContentIdentifier queryContentIdentifier();
  62
  63     /** returns the content ( "most expensive method" ).
  64
  65         @returns
  66         the content.
  67     */
  68     XContent queryContent();
  69 };
  70
  71
  72 }; }; }; };
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */