/* -*- 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 .
*/
module com { module sun { module star { module sdb {
/** allows operating on a sub document of an OfficeDatabaseDocument
@since OOo 3.1
*/
interface XSubDocument
{
/** opens the sub document
<p>Note that opening the document means it is displayed in an own top-level frame
on the desktop.</p>
@return
the sub document, usually a com::sun::star::frame::XModel,
or a com::sun::star::frame::XController if the sub document
does not have an own model.
@throws ::com::sun::star::lang::WrappedTargetException
if an error occurs during opening the document
*/
::com::sun::star::lang::XComponent
open()
raises( ::com::sun::star::lang::WrappedTargetException );
/** opens the sub document in design mode
@return
the sub document, usually a com::sun::star::frame::XModel,
or a com::sun::star::frame::XController if the sub document
does not have an own model.
@throws ::com::sun::star::lang::WrappedTargetException
if an error occurs during opening the document
*/
::com::sun::star::lang::XComponent
openDesign()
raises( ::com::sun::star::lang::WrappedTargetException );
/** stores the sub document, if it had previously been opened in either mode
@throws ::com::sun::star::lang::WrappedTargetException
if an error occurs during storing the document
*/
void store()
raises( ::com::sun::star::lang::WrappedTargetException );
/** closes the sub document, if it had previously been opened in either mode
@return `TRUE` if and only if the document could be closed, `FALSE` otherwise,
e.g. if the closing has been vetoed by the user.
@throws ::com::sun::star::lang::WrappedTargetException
if an error occurs during closing the document
*/
boolean close()
raises( ::com::sun::star::lang::WrappedTargetException );
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
