1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdb_XSubDocument_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_sdb_XSubDocument_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/WrappedTargetException.idl> 28*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/XComponent.idl> 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//============================================================================= 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module sdb { 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski/** allows operating on a sub document of an <type>OfficeDatabaseDocument</type> 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski @since OpenOffice 3.1 39*b1cdbd2cSJim Jagielski */ 40*b1cdbd2cSJim Jagielskipublished interface XSubDocument 41*b1cdbd2cSJim Jagielski{ 42*b1cdbd2cSJim Jagielski /** opens the sub document 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski <p>Note that opening the document means it is displayed in an own top-level frame 45*b1cdbd2cSJim Jagielski on the desktop.</p> 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski @return 48*b1cdbd2cSJim Jagielski the sub document, usually an <type scope="com::sun::star::frame">XModel</type>, 49*b1cdbd2cSJim Jagielski or an <type scope="com::sun::star::frame">XController</type> if the sub document 50*b1cdbd2cSJim Jagielski does not have an own model. 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::WrappedTargetException 53*b1cdbd2cSJim Jagielski if an error occurs during opening the document 54*b1cdbd2cSJim Jagielski */ 55*b1cdbd2cSJim Jagielski ::com::sun::star::lang::XComponent 56*b1cdbd2cSJim Jagielski open() 57*b1cdbd2cSJim Jagielski raises( ::com::sun::star::lang::WrappedTargetException ); 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski /** opens the sub document in design mode 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski @return 62*b1cdbd2cSJim Jagielski the sub document, usually an <type scope="com::sun::star::frame">XModel</type>, 63*b1cdbd2cSJim Jagielski or an <type scope="com::sun::star::frame">XController</type> if the sub document 64*b1cdbd2cSJim Jagielski does not have an own model. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::WrappedTargetException 67*b1cdbd2cSJim Jagielski if an error occurs during opening the document 68*b1cdbd2cSJim Jagielski */ 69*b1cdbd2cSJim Jagielski ::com::sun::star::lang::XComponent 70*b1cdbd2cSJim Jagielski openDesign() 71*b1cdbd2cSJim Jagielski raises( ::com::sun::star::lang::WrappedTargetException ); 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski /** stores the sub document, if it had previously been opened in either mode 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::WrappedTargetException 76*b1cdbd2cSJim Jagielski if an error occurs during storing the document 77*b1cdbd2cSJim Jagielski */ 78*b1cdbd2cSJim Jagielski void store() 79*b1cdbd2cSJim Jagielski raises( ::com::sun::star::lang::WrappedTargetException ); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski /** closes the sub document, if it had previously been opened in either mode 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski @return <TRUE/> if and only if the document could be closed, <FALSE/> otherwise, 84*b1cdbd2cSJim Jagielski e.g. if the closing has been vetoed by the user. 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::WrappedTargetException 87*b1cdbd2cSJim Jagielski if an error occurs during closing the document 88*b1cdbd2cSJim Jagielski */ 89*b1cdbd2cSJim Jagielski boolean close() 90*b1cdbd2cSJim Jagielski raises( ::com::sun::star::lang::WrappedTargetException ); 91*b1cdbd2cSJim Jagielski}; 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski//============================================================================= 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski}; }; }; }; 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski//============================================================================= 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski#endif 100