offapi/com/sun/star/document/XStandaloneDocumentInfo.idl

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