offapi/com/sun/star/document/XStandaloneDocumentInfo.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: XStandaloneDocumentInfo.idl,v $
  10  * $Revision: 1.10 $
  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_document_XStandaloneDocumentInfo_idl__
  31 #define __com_sun_star_document_XStandaloneDocumentInfo_idl__
  32
  33 #ifndef __com_sun_star_document_XDocumentInfo_idl__
  34 #include <com/sun/star/document/XDocumentInfo.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_IOException_idl__
  38 #include <com/sun/star/io/IOException.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {   module sun {   module star {   module document {
  44
  45 //=============================================================================
  46 /** makes it possible to load document information from
  47     a resource specified by a URL and to store it into a resource also
  48     specified by a URL
  49
  50     <p>
  51     Only the document information part of the resource is transferred.
  52     Instead of <type>DocumentInfo</type> not the whole document will be opened.
  53     Note: Without specifying the source or target of this info (the document)
  54     nothing can work and will be handled as void (for reading) or ignored (for writing).
  55     After specigiying the source/target by using this interface,
  56     the interface <type>XDocumentInfo</type> (which must be implemented on same
  57     object then this one!) provides access to the info properties.
  58     </p>
  59
  60     @deprecated     Use <type>XDocumentProperties</type> instead.
  61
  62     @see DocumentInfo
  63     @see StandaloneDocumentInfo
  64     @see XDocumentInfo
  65  */
  66 published interface XStandaloneDocumentInfo: XDocumentInfo
  67 {
  68     //-------------------------------------------------------------------------
  69     /** loads the document information from a file referred by an URL
  70
  71         <p>
  72         After an unsuccessful call the contents of the document
  73         information are undefined (void).
  74         This method only works for storage file formats.
  75         </p>
  76
  77         @param URL
  78             specifies the source of information
  79
  80         @throws com::sun::star::io::IOException
  81             if storage couldn't be found or opened
  82      */
  83     void loadFromURL( [in] string URL )
  84         raises( com::sun::star::io::IOException );
  85
  86     //-------------------------------------------------------------------------
  87     /** stores the document information into a file referred by a URL
  88
  89         <p>
  90         Only the document information part of the document is overwritten.
  91         This method only works for storage file formats.
  92         </p>
  93
  94         @param URL
  95             specifies the target for saving
  96
  97         @throws com::sun::star::io::IOException
  98             if storage couldn't be found or opened
  99      */
 100     void storeIntoURL( [in] string URL )
 101         raises( com::sun::star::io::IOException );
 102 };
 103
 104 //=============================================================================
 105
 106 }; }; }; };
 107
 108 #endif