offapi/com/sun/star/frame/XLoadable.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 #ifndef __com_sun_star_frame_XLoadable_idl__
  20 #define __com_sun_star_frame_XLoadable_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/io/IOException.idl>
  24 #include <com/sun/star/frame/DoubleInitializationException.idl>
  25 #include <com/sun/star/beans/PropertyValue.idl>
  26
  27
  28
  29  module com {  module sun {  module star {  module frame {
  30
  31 /** offers a simple way to initialize a component or load it from an URL.
  32     <p>In case an object supports the interface the object must be initialized
  33        with either initNew() or load() call before any usage. In case the object
  34        is already initialized the mentioned methods should throw DoubleInitializationException.
  35     </p>
  36
  37     @since OOo 1.1.2
  38  */
  39 published interface XLoadable: com::sun::star::uno::XInterface
  40 {
  41     /** creates a component from scratch
  42     */
  43     void initNew()
  44         raises( DoubleInitializationException, com::sun::star::io::IOException, com::sun::star::uno::Exception );
  45
  46     /** loads a component from an URL
  47         @param lArguments
  48             parameters for saving
  49             (see com::sun::star::document::MediaDescriptor for further details)
  50             the FileName parameter must be specified, other parameters are optional
  51     */
  52
  53     void load( [in] sequence<com::sun::star::beans::PropertyValue> lArguments )
  54         raises( DoubleInitializationException, com::sun::star::io::IOException, com::sun::star::uno::Exception );
  55
  56 };
  57
  58
  59 }; }; }; };
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */