offapi/com/sun/star/sdb/XSubDocument.idl

   1 /*************************************************************************
   2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3 *
   4 * Copyright 2008 by Sun Microsystems, Inc.
   5 *
   6 * OpenOffice.org - a multi-platform office productivity suite
   7 *
   8 * $RCSfile: XSubDocument.idl,v $
   9 *
  10 * $Revision: 1.2 $
  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_sdb_XSubDocument_idl__
  31 #define __com_sun_star_sdb_XSubDocument_idl__
  32
  33 #include <com/sun/star/lang/WrappedTargetException.idl>
  34 #include <com/sun/star/lang/XComponent.idl>
  35
  36 //=============================================================================
  37
  38 module com { module sun { module star { module sdb {
  39
  40 //=============================================================================
  41
  42 /** allows operating on a sub document of an <type>OfficeDatabaseDocument</type>
  43
  44     @since OOo 3.1
  45  */
  46 interface XSubDocument
  47 {
  48     /** opens the sub document
  49
  50         <p>Note that opening the document means it is displayed in an own top-level frame
  51         on the desktop.</p>
  52
  53         @return
  54             the sub document, usually an <type scope="com::sun::star::frame">XModel</type>,
  55             or an <type scope="com::sun::star::frame">XController</type> if the sub document
  56             does not have an own model.
  57
  58         @raises ::com::sun::star::lang::WrappedTargetException
  59             if an error occurs during opening the document
  60     */
  61     ::com::sun::star::lang::XComponent
  62             open()
  63                 raises( ::com::sun::star::lang::WrappedTargetException );
  64
  65     /** opens the sub document in design mode
  66
  67         @return
  68             the sub document, usually an <type scope="com::sun::star::frame">XModel</type>,
  69             or an <type scope="com::sun::star::frame">XController</type> if the sub document
  70             does not have an own model.
  71
  72         @raises ::com::sun::star::lang::WrappedTargetException
  73             if an error occurs during opening the document
  74     */
  75     ::com::sun::star::lang::XComponent
  76             openDesign()
  77                 raises( ::com::sun::star::lang::WrappedTargetException );
  78
  79     /** stores the sub document, if it had previously been opened in either mode
  80
  81         @raises ::com::sun::star::lang::WrappedTargetException
  82             if an error occurs during storing the document
  83     */
  84     void    store()
  85                 raises( ::com::sun::star::lang::WrappedTargetException );
  86
  87     /** closes the sub document, if it had previously been opened in either mode
  88
  89         @return <TRUE/> if and only if the document could be closed, <FALSE/> otherwise,
  90             e.g. if the closing has been vetoed by the user.
  91
  92         @raises ::com::sun::star::lang::WrappedTargetException
  93             if an error occurs during closing the document
  94     */
  95     boolean close()
  96                 raises( ::com::sun::star::lang::WrappedTargetException );
  97 };
  98
  99 //=============================================================================
 100
 101 }; }; }; };
 102
 103 //=============================================================================
 104
 105 #endif