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#ifndef __com_sun_star_sdb_OfficeDatabaseDocument_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_sdb_OfficeDatabaseDocument_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_document_OfficeDocument_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/document/OfficeDocument.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdb_XOfficeDatabaseDocument_idl__ 30*b1cdbd2cSJim Jagielski#include <com/sun/star/sdb/XOfficeDatabaseDocument.idl> 31*b1cdbd2cSJim Jagielski#endif 32*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_document_XDocumentEventBroadcaster_idl__ 33*b1cdbd2cSJim Jagielski#include <com/sun/star/document/XDocumentEventBroadcaster.idl> 34*b1cdbd2cSJim Jagielski#endif 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_script_provider_XScriptProviderSupplier_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/script/provider/XScriptProviderSupplier.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_frame_XLoadable_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/frame/XLoadable.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_util_XCloseable_idl__ 42*b1cdbd2cSJim Jagielski#include <com/sun/star/util/XCloseable.idl> 43*b1cdbd2cSJim Jagielski#endif 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module sdb { 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski/** specifies a office database document which is a storable document. 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski <p>These documents contain information about forms, and reports, and the properties of a data source.</p> 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski <p>The database document contains no data per default. The following is stored inside the document: 52*b1cdbd2cSJim Jagielski <ul> 53*b1cdbd2cSJim Jagielski <li>forms</li> 54*b1cdbd2cSJim Jagielski <li>reports</li> 55*b1cdbd2cSJim Jagielski <li>The table settings defined in <type>DataSettings</type></li> 56*b1cdbd2cSJim Jagielski <li>The query settings defined in <type>DataSettings</type></li> 57*b1cdbd2cSJim Jagielski <li>All properties of the service <type>DataSource</type></li> 58*b1cdbd2cSJim Jagielski </ul></p> 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski @see com::sun::star::sdb::XOfficeDatabaseDocument 61*b1cdbd2cSJim Jagielski @see com::sun::star::document::OfficeDocument 62*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 63*b1cdbd2cSJim Jagielski */ 64*b1cdbd2cSJim Jagielskiservice OfficeDatabaseDocument 65*b1cdbd2cSJim Jagielski{ 66*b1cdbd2cSJim Jagielski /** specifies basic functionality of a document in OpenOffice.org 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski <p>Note that a database document actually does not support the <type scope="com::sun::star::view">XPrintable</type> interface. 69*b1cdbd2cSJim Jagielski The non-optional requirement of this interface in the <type scope="com::sun::star::document">OfficeDocument</type> 70*b1cdbd2cSJim Jagielski service is considered a documentation error.</p> 71*b1cdbd2cSJim Jagielski */ 72*b1cdbd2cSJim Jagielski service com::sun::star::document::OfficeDocument; 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski interface XOfficeDatabaseDocument; 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski /** allows access to the Basic macros and dialogs possibly embedded in the document 77*b1cdbd2cSJim Jagielski @since OpenOffice 3.1 78*b1cdbd2cSJim Jagielski */ 79*b1cdbd2cSJim Jagielski interface ::com::sun::star::document::XEmbeddedScripts; 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski /** supplies a script provider which can be used to execute macros and scripts 82*b1cdbd2cSJim Jagielski embedded in the document 83*b1cdbd2cSJim Jagielski @since OpenOffice 3.1 84*b1cdbd2cSJim Jagielski */ 85*b1cdbd2cSJim Jagielski interface ::com::sun::star::script::provider::XScriptProviderSupplier; 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski /** allows to initialize the the document, either from scratch, or from a stored 88*b1cdbd2cSJim Jagielski database document. 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski <p>A newly instantiated database document cannot be operated until it is fully 91*b1cdbd2cSJim Jagielski initialized. There are three possible means to do this initialization: 92*b1cdbd2cSJim Jagielski <ul><li>calling <code>XLoadable::initNew</code></li> 93*b1cdbd2cSJim Jagielski <li>calling <code>XLoadable::load</code></li> 94*b1cdbd2cSJim Jagielski <li>calling <code>XStorable::storeAsURL</code></li> 95*b1cdbd2cSJim Jagielski </ul> 96*b1cdbd2cSJim Jagielski The third option was added for compatibility reasons, since a <type>DatabaseDocument</type> 97*b1cdbd2cSJim Jagielski in earlier versions of OpenOffice.org did not support the <code>XLoadable</code> interface, 98*b1cdbd2cSJim Jagielski so the usual way of creating a document from scratch was to create it, set properties as 99*b1cdbd2cSJim Jagielski needed, and store it.</p> 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski @since OpenOffice 3.1 102*b1cdbd2cSJim Jagielski */ 103*b1cdbd2cSJim Jagielski interface ::com::sun::star::frame::XLoadable; 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski /** allows to register for notifications happening in the document 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski <p>The following events are broadcasted by a database document 108*b1cdbd2cSJim Jagielski <table border="1" frame="all"> 109*b1cdbd2cSJim Jagielski <thead> 110*b1cdbd2cSJim Jagielski <tr><td><strong>Event Name</strong></td> 111*b1cdbd2cSJim Jagielski <td><strong>broadcasted when</strong></td> 112*b1cdbd2cSJim Jagielski <td align="center"><strong>broadcasted synchronously</strong></td> 113*b1cdbd2cSJim Jagielski </tr> 114*b1cdbd2cSJim Jagielski </thead> 115*b1cdbd2cSJim Jagielski <tbody> 116*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnCreate</em></td> 117*b1cdbd2cSJim Jagielski <td>the document has been newly created. This does not imply that the document has 118*b1cdbd2cSJim Jagielski been loaded into a frame, it just means the initialization has been finished.</td> 119*b1cdbd2cSJim Jagielski <td align="center">yes</td> 120*b1cdbd2cSJim Jagielski </tr> 121*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnLoadFinished</em></td> 122*b1cdbd2cSJim Jagielski <td>the document has been completely loaded. This does not imply that the document 123*b1cdbd2cSJim Jagielski has been loaded into a frame, it just means the load process has been finished.</td> 124*b1cdbd2cSJim Jagielski <td align="center">yes</td> 125*b1cdbd2cSJim Jagielski </tr> 126*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnNew</em></td> 127*b1cdbd2cSJim Jagielski <td>the document has been initialized from scratch, including plugging it into a frame.</td> 128*b1cdbd2cSJim Jagielski <td align="center">no</td> 129*b1cdbd2cSJim Jagielski </tr> 130*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnLoad</em></td> 131*b1cdbd2cSJim Jagielski <td>the document has been completely loaded, including plugging it into a frame.</td> 132*b1cdbd2cSJim Jagielski <td align="center">no</td> 133*b1cdbd2cSJim Jagielski </tr> 134*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnSave</em></td> 135*b1cdbd2cSJim Jagielski <td>the document is about to be saved.</td> 136*b1cdbd2cSJim Jagielski <td align="center">yes</td> 137*b1cdbd2cSJim Jagielski </tr> 138*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnSaveDone</em></td> 139*b1cdbd2cSJim Jagielski <td>saving the document succeeeded.</td> 140*b1cdbd2cSJim Jagielski <td align="center">no</td> 141*b1cdbd2cSJim Jagielski </tr> 142*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnSaveFailed</em></td> 143*b1cdbd2cSJim Jagielski <td>saving the document failed.</td> 144*b1cdbd2cSJim Jagielski <td align="center">no</td> 145*b1cdbd2cSJim Jagielski </tr> 146*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnSaveAs</em></td> 147*b1cdbd2cSJim Jagielski <td>the document is about to be saved under a new name.</td> 148*b1cdbd2cSJim Jagielski <td align="center">yes</td> 149*b1cdbd2cSJim Jagielski </tr> 150*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnSaveAsDone</em></td> 151*b1cdbd2cSJim Jagielski <td>saving the document under a new name succeeeded.</td> 152*b1cdbd2cSJim Jagielski <td align="center">no</td> 153*b1cdbd2cSJim Jagielski </tr> 154*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnSaveAsFailed</em></td> 155*b1cdbd2cSJim Jagielski <td>saving the document under a new name failed.</td> 156*b1cdbd2cSJim Jagielski <td align="center">no</td> 157*b1cdbd2cSJim Jagielski </tr> 158*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnSaveTo</em></td> 159*b1cdbd2cSJim Jagielski <td>the document is about to be saved to a location different from its 160*b1cdbd2cSJim Jagielski current location, but without adjusting the current location.</td> 161*b1cdbd2cSJim Jagielski <td align="center">yes</td> 162*b1cdbd2cSJim Jagielski </tr> 163*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnSaveToDone</em></td> 164*b1cdbd2cSJim Jagielski <td>saving the document to a different location succeeeded.</td> 165*b1cdbd2cSJim Jagielski <td align="center">no</td> 166*b1cdbd2cSJim Jagielski </tr> 167*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnSaveToFailed</em></td> 168*b1cdbd2cSJim Jagielski <td>saving the document to a different location failed.</td> 169*b1cdbd2cSJim Jagielski <td align="center">no</td> 170*b1cdbd2cSJim Jagielski </tr> 171*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnPrepareUnload</em></td> 172*b1cdbd2cSJim Jagielski <td>the document is about to be closed.</td> 173*b1cdbd2cSJim Jagielski <td align="center">yes</td> 174*b1cdbd2cSJim Jagielski </tr> 175*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnUnload</em></td> 176*b1cdbd2cSJim Jagielski <td>the document is being closed.</td> 177*b1cdbd2cSJim Jagielski <td align="center">yes</td> 178*b1cdbd2cSJim Jagielski </tr> 179*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnFocus</em></td> 180*b1cdbd2cSJim Jagielski <td>a view to the document obtained the focus.</td> 181*b1cdbd2cSJim Jagielski <td align="center">no</td> 182*b1cdbd2cSJim Jagielski </tr> 183*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnUnfocus</em></td> 184*b1cdbd2cSJim Jagielski <td>a view to the document lost the focus.</td> 185*b1cdbd2cSJim Jagielski <td align="center">no</td> 186*b1cdbd2cSJim Jagielski </tr> 187*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnModifyChanged</em></td> 188*b1cdbd2cSJim Jagielski <td>the <quot>modified</quot> state of the document changed.</td> 189*b1cdbd2cSJim Jagielski <td align="center">no</td> 190*b1cdbd2cSJim Jagielski </tr> 191*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnViewCreated</em></td> 192*b1cdbd2cSJim Jagielski <td>a view to the document has been created, and attached to the document.</td> 193*b1cdbd2cSJim Jagielski <td align="center">no</td> 194*b1cdbd2cSJim Jagielski </tr> 195*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnPrepareViewClosing</em></td> 196*b1cdbd2cSJim Jagielski <td>a view to the document is about to be closed.</td> 197*b1cdbd2cSJim Jagielski <td align="center">yes</td> 198*b1cdbd2cSJim Jagielski </tr> 199*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnViewClosed</em></td> 200*b1cdbd2cSJim Jagielski <td>a view to the document has been closed.</td> 201*b1cdbd2cSJim Jagielski <td align="center">no</td> 202*b1cdbd2cSJim Jagielski </tr> 203*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnTitleChanged</em></td> 204*b1cdbd2cSJim Jagielski <td>the title of the document changed.</td> 205*b1cdbd2cSJim Jagielski <td align="center">no</td> 206*b1cdbd2cSJim Jagielski </tr> 207*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnSubComponentOpened</em></td> 208*b1cdbd2cSJim Jagielski <td>From with a view to the document, a view to a sub component (e.g. a table or a report) has been opened.</td> 209*b1cdbd2cSJim Jagielski <td align="center">no</td> 210*b1cdbd2cSJim Jagielski </tr> 211*b1cdbd2cSJim Jagielski <tr><td valign="top"><em>OnSubComponentClosed</em></td> 212*b1cdbd2cSJim Jagielski <td>From with a view to the document, a view to a sub component (e.g. a table or a report) has been closed.</td> 213*b1cdbd2cSJim Jagielski <td align="center">no</td> 214*b1cdbd2cSJim Jagielski </tr> 215*b1cdbd2cSJim Jagielski </tbody> 216*b1cdbd2cSJim Jagielski </table> 217*b1cdbd2cSJim Jagielski </p> 218*b1cdbd2cSJim Jagielski 219*b1cdbd2cSJim Jagielski @since OpenOffice 3.1 220*b1cdbd2cSJim Jagielski */ 221*b1cdbd2cSJim Jagielski interface ::com::sun::star::document::XDocumentEventBroadcaster; 222*b1cdbd2cSJim Jagielski 223*b1cdbd2cSJim Jagielski /** implements life time control 224*b1cdbd2cSJim Jagielski 225*b1cdbd2cSJim Jagielski <p>Whoever retrieves a <type>OfficeDatabaseDocument</type> should be aware of 226*b1cdbd2cSJim Jagielski life time issues, since a document needs to be closed when nobody needs it anymore.</p> 227*b1cdbd2cSJim Jagielski 228*b1cdbd2cSJim Jagielski <p>This implies that clients of a document need to ensure that as soon as they don't 229*b1cdbd2cSJim Jagielski need, they invoke <member scope="com::sun::star::util">XCloseable::close</member>.</p> 230*b1cdbd2cSJim Jagielski 231*b1cdbd2cSJim Jagielski <p>Since this can be done by multiple clients, every client is additionally required 232*b1cdbd2cSJim Jagielski to register itself as <type scope="com::sun::star::util">XCloseListener</type> at 233*b1cdbd2cSJim Jagielski the document, to prevent some other client closing the model while it's still needed 234*b1cdbd2cSJim Jagielski by the first client.</p> 235*b1cdbd2cSJim Jagielski */ 236*b1cdbd2cSJim Jagielski interface com::sun::star::util::XCloseable; 237*b1cdbd2cSJim Jagielski}; 238*b1cdbd2cSJim Jagielski 239*b1cdbd2cSJim Jagielski//============================================================================= 240*b1cdbd2cSJim Jagielski 241*b1cdbd2cSJim Jagielski}; }; }; }; 242*b1cdbd2cSJim Jagielski 243*b1cdbd2cSJim Jagielski/*=========================================================================== 244*b1cdbd2cSJim Jagielski===========================================================================*/ 245*b1cdbd2cSJim Jagielski#endif 246*b1cdbd2cSJim Jagielski 247