diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-upstream/4%7.4.7.tar.xz libreoffice-upstream/4%7.4.7.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl | 226 |
1 files changed, 226 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl b/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl new file mode 100644 index 000000000..90f1edc0f --- /dev/null +++ b/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl @@ -0,0 +1,226 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_sdb_OfficeDatabaseDocument_idl__ +#define __com_sun_star_sdb_OfficeDatabaseDocument_idl__ + +#include <com/sun/star/document/OfficeDocument.idl> +#include <com/sun/star/sdb/XOfficeDatabaseDocument.idl> +#include <com/sun/star/document/XDocumentEventBroadcaster.idl> +#include <com/sun/star/script/provider/XScriptProviderSupplier.idl> +#include <com/sun/star/frame/XLoadable.idl> +#include <com/sun/star/util/XCloseable.idl> + +module com { module sun { module star { module sdb { + +/** specifies an office database document which is a storable document. + + <p>These documents contain information about forms, and reports, and the properties of a data source.</p> + + <p>The database document contains no data per default. The following is stored inside the document: + <ul> + <li>forms</li> + <li>reports</li> + <li>The table settings defined in DataSettings</li> + <li>The query settings defined in DataSettings</li> + <li>All properties of the service DataSource</li> + </ul></p> + + @see com::sun::star::sdb::XOfficeDatabaseDocument + @see com::sun::star::document::OfficeDocument + @since OOo 2.0 + */ +service OfficeDatabaseDocument +{ + /** specifies basic functionality of a document in OpenOffice.org + + <p>Note that a database document actually does not support the com::sun::star::view::XPrintable interface. + The non-optional requirement of this interface in the com::sun::star::document::OfficeDocument + service is considered a documentation error.</p> + */ + service com::sun::star::document::OfficeDocument; + + interface XOfficeDatabaseDocument; + + /** allows access to the Basic macros and dialogs possibly embedded in the document + @since OOo 3.1 + */ + interface ::com::sun::star::document::XEmbeddedScripts; + + /** supplies a script provider which can be used to execute macros and scripts + embedded in the document + @since OOo 3.1 + */ + interface ::com::sun::star::script::provider::XScriptProviderSupplier; + + /** allows to initialize the document, either from scratch, or from a stored + database document. + + <p>A newly instantiated database document cannot be operated until it is fully + initialized. There are three possible means to do this initialization: + <ul><li>calling <code>XLoadable::initNew</code></li> + <li>calling <code>XLoadable::load</code></li> + <li>calling <code>XStorable::storeAsURL</code></li> + </ul> + The third option was added for compatibility reasons, since a DatabaseDocument + in earlier versions of OpenOffice.org did not support the <code>XLoadable</code> interface, + so the usual way of creating a document from scratch was to create it, set properties as + needed, and store it.</p> + + @since OOo 3.1 + */ + interface ::com::sun::star::frame::XLoadable; + + /** allows to register for notifications happening in the document + + <p>The following events are broadcasted by a database document + <table border="1" frame="all"> + <tr><td><strong>Event Name</strong></td> + <td><strong>broadcasted when</strong></td> + <td align="center"><strong>broadcasted synchronously</strong></td> + </tr> + <tr><td valign="top"><em>OnCreate</em></td> + <td>the document has been newly created. This does not imply that the document has + been loaded into a frame, it just means the initialization has been finished.</td> + <td align="center">yes</td> + </tr> + <tr><td valign="top"><em>OnLoadFinished</em></td> + <td>the document has been completely loaded. This does not imply that the document + has been loaded into a frame, it just means the load process has been finished.</td> + <td align="center">yes</td> + </tr> + <tr><td valign="top"><em>OnNew</em></td> + <td>the document has been initialized from scratch, including plugging it into a frame.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnLoad</em></td> + <td>the document has been completely loaded, including plugging it into a frame.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnSave</em></td> + <td>the document is about to be saved.</td> + <td align="center">yes</td> + </tr> + <tr><td valign="top"><em>OnSaveDone</em></td> + <td>saving the document succeeded.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnSaveFailed</em></td> + <td>saving the document failed.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnSaveAs</em></td> + <td>the document is about to be saved under a new name.</td> + <td align="center">yes</td> + </tr> + <tr><td valign="top"><em>OnSaveAsDone</em></td> + <td>saving the document under a new name succeeded.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnSaveAsFailed</em></td> + <td>saving the document under a new name failed.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnSaveTo</em></td> + <td>the document is about to be saved to a location different from its + current location, but without adjusting the current location.</td> + <td align="center">yes</td> + </tr> + <tr><td valign="top"><em>OnSaveToDone</em></td> + <td>saving the document to a different location succeeded.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnSaveToFailed</em></td> + <td>saving the document to a different location failed.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnPrepareUnload</em></td> + <td>the document is about to be closed.</td> + <td align="center">yes</td> + </tr> + <tr><td valign="top"><em>OnUnload</em></td> + <td>the document is being closed.</td> + <td align="center">yes</td> + </tr> + <tr><td valign="top"><em>OnFocus</em></td> + <td>a view to the document obtained the focus.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnUnfocus</em></td> + <td>a view to the document lost the focus.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnModifyChanged</em></td> + <td>the <em>modified</em> state of the document changed.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnViewCreated</em></td> + <td>a view to the document has been created, and attached to the document.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnPrepareViewClosing</em></td> + <td>a view to the document is about to be closed.</td> + <td align="center">yes</td> + </tr> + <tr><td valign="top"><em>OnViewClosed</em></td> + <td>a view to the document has been closed.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnTitleChanged</em></td> + <td>the title of the document changed.</td> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnSubComponentOpened</em></td> + <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> + <td align="center">no</td> + </tr> + <tr><td valign="top"><em>OnSubComponentClosed</em></td> + <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> + <td align="center">no</td> + </tr> + </table> + </p> + + @since OOo 3.1 + */ + interface ::com::sun::star::document::XDocumentEventBroadcaster; + + /** implements life time control + + <p>Whoever retrieves an OfficeDatabaseDocument should be aware of + life time issues, since a document needs to be closed when nobody needs it anymore.</p> + + <p>This implies that clients of a document need to ensure that as soon as they don't + need, they invoke com::sun::star::util::XCloseable::close().</p> + + <p>Since this can be done by multiple clients, every client is additionally required + to register itself as com::sun::star::util::XCloseListener at + the document, to prevent some other client closing the model while it's still needed + by the first client.</p> + */ + interface com::sun::star::util::XCloseable; +}; + + +}; }; }; }; + +/*=========================================================================== +===========================================================================*/ +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |