/*************************************************************************
 *
 *  $RCSfile: XLoadable.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: hr $ $Date: 2003-03-26 13:53:55 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_form_XLoadable_idl__
#define __com_sun_star_form_XLoadable_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_form_XLoadListener_idl__
#include <com/sun/star/form/XLoadListener.idl>
#endif

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

 module com {  module sun {  module star {  module form {

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

/** provides functionality to implement objects which may be loaded.

    <p>The object is typically implemented by high-level objects which can connect to a data source.</p>

    @see XLoadListener
 */
interface XLoadable: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** loads the data.
     */
    [oneway] void load();

    //-------------------------------------------------------------------------

    /** unloads the data.
     */
    [oneway] void unload();

    //-------------------------------------------------------------------------

    /** does a smart refresh of the object.

        <p>The final state will be the same as if unload and load were called, but reload
        is the more efficient way to do the same. If the object isn't loaded, nothing happens.</p>
     */
    [oneway] void reload();

    //-------------------------------------------------------------------------

    /** returns if the object is in loaded state.
     */
    boolean isLoaded();

    //-------------------------------------------------------------------------

    /** adds the specified listener to receive load-related events

        @param aListener
            the listener to add.
     */
    [oneway] void addLoadListener( [in] com::sun::star::form::XLoadListener aListener );

    //-------------------------------------------------------------------------

    /** removes the specified listener.

        @param aListener
            the listener to remove.
     */
    [oneway] void removeLoadListener( [in] com::sun::star::form::XLoadListener aListener );
};

}; }; }; };

#endif

/*=============================================================================

=============================================================================*/