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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module sdb {
  22
  23
  24 /** allows operating on a sub document of an OfficeDatabaseDocument
  25
  26     @since OOo 3.1
  27  */
  28 interface XSubDocument
  29 {
  30     /** opens the sub document
  31
  32         <p>Note that opening the document means it is displayed in an own top-level frame
  33         on the desktop.</p>
  34
  35         @return
  36             the sub document, usually a com::sun::star::frame::XModel,
  37             or a com::sun::star::frame::XController if the sub document
  38             does not have an own model.
  39
  40         @throws ::com::sun::star::lang::WrappedTargetException
  41             if an error occurs during opening the document
  42     */
  43     ::com::sun::star::lang::XComponent
  44             open()
  45                 raises( ::com::sun::star::lang::WrappedTargetException );
  46
  47     /** opens the sub document in design mode
  48
  49         @return
  50             the sub document, usually a com::sun::star::frame::XModel,
  51             or a com::sun::star::frame::XController if the sub document
  52             does not have an own model.
  53
  54         @throws ::com::sun::star::lang::WrappedTargetException
  55             if an error occurs during opening the document
  56     */
  57     ::com::sun::star::lang::XComponent
  58             openDesign()
  59                 raises( ::com::sun::star::lang::WrappedTargetException );
  60
  61     /** stores the sub document, if it had previously been opened in either mode
  62
  63         @throws ::com::sun::star::lang::WrappedTargetException
  64             if an error occurs during storing the document
  65     */
  66     void    store()
  67                 raises( ::com::sun::star::lang::WrappedTargetException );
  68
  69     /** closes the sub document, if it had previously been opened in either mode
  70
  71         @return `TRUE` if and only if the document could be closed, `FALSE` otherwise,
  72             e.g. if the closing has been vetoed by the user.
  73
  74         @throws ::com::sun::star::lang::WrappedTargetException
  75             if an error occurs during closing the document
  76     */
  77     boolean close()
  78                 raises( ::com::sun::star::lang::WrappedTargetException );
  79 };
  80
  81
  82 }; }; }; };
  83
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */