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

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