offapi/com/sun/star/frame/XLoadable.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XLoadable.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_frame_XLoadable_idl__
  31 #define __com_sun_star_frame_XLoadable_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_IOException_idl__
  38 #include <com/sun/star/io/IOException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_frame_DoubleInitializationException_idl__
  42 #include <com/sun/star/frame/DoubleInitializationException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_beans_PropertyValue_idl__
  46 #include <com/sun/star/beans/PropertyValue.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module frame {
  53
  54 //=============================================================================
  55 /** offers a simple way to initialize a component or load it from an URL.
  56     <p>In case an object supports the interface the object must be initialized
  57        with either initNew() or load() call before any usage. In case the object
  58        is already initialized the mentioned methods should throw DoubleInitializationException.
  59     </p>
  60
  61     @since OOo 1.1.2
  62  */
  63 published interface XLoadable: com::sun::star::uno::XInterface
  64 {
  65     //-------------------------------------------------------------------------
  66     /** creates a component from scratch
  67     */
  68     void initNew()
  69         raises( DoubleInitializationException, com::sun::star::io::IOException, com::sun::star::uno::Exception );
  70
  71     //-------------------------------------------------------------------------
  72     /** loads a component from an URL
  73         @param lArguments
  74             parameters for saving
  75             (see <type scope="com::sun::star::document">MediaDescriptor</type> for further details)
  76             the FileName parameter must be specified, other parameters are optional
  77     */
  78
  79     void load( [in] sequence<com::sun::star::beans::PropertyValue> lArguments )
  80         raises( DoubleInitializationException, com::sun::star::io::IOException, com::sun::star::uno::Exception );
  81
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; };
  87
  88 #endif