/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_frame_XLoadable_idl__
#define __com_sun_star_frame_XLoadable_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/io/IOException.idl>
#include <com/sun/star/frame/DoubleInitializationException.idl>
#include <com/sun/star/beans/PropertyValue.idl>


//=============================================================================

 module com {  module sun {  module star {  module frame {

//=============================================================================
/** offers a simple way to initialize a component or load it from an URL.
    <p>In case an object supports the interface the object must be initialized
       with either initNew() or load() call before any usage. In case the object
       is already initialized the mentioned methods should throw DoubleInitializationException.
    </p>

    @since OOo 1.1.2
 */
published interface XLoadable: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** creates a component from scratch
    */
    void initNew()
        raises( DoubleInitializationException, com::sun::star::io::IOException, com::sun::star::uno::Exception );

    //-------------------------------------------------------------------------
    /** loads a component from an URL
        @param lArguments
            parameters for saving
            (see <type scope="com::sun::star::document">MediaDescriptor</type> for further details)
            the FileName parameter must be specified, other parameters are optional
    */

    void load( [in] sequence<com::sun::star::beans::PropertyValue> lArguments )
        raises( DoubleInitializationException, com::sun::star::io::IOException, com::sun::star::uno::Exception );

};

//=============================================================================

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
