/*************************************************************************
 *
 *  $RCSfile: XViewDataSupplier.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: mi $ $Date: 2002/10/03 13:04:13 $
 *
 *  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_document_XViewDataSupplier_idl__
#define __com_sun_star_document_XViewDataSupplier_idl__

#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

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

module com { module sun { module star { module document {

//=============================================================================
/** gives access to some properties describing all open views to a document

    <p>
    Each view is described by a sequence< ::com::sun::star::beans::PropertyValue >.
    Through this interface the state of all open views can be retrieved and restored
    later. These states can also be made persistent so that a document loader can create
    all views of the correct types and restore their state to the state when the document was
    saved.
    </p>
 */
interface XViewDataSupplier: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
    /** retrieve informations about currently opened view to restore it later

        @returns
            a <type scope="com::sun::star::container">XIndexAccess</type>,
            that gives access to a list of <type scope="com::sun::star::beans">PropertyValue</type>
            for every open view. May <NULL/> if no view is currently available.
	 */
    ::com::sun::star::container::XIndexAccess getViewData();

	//-------------------------------------------------------------------------
    /** restore all views which will be represented by given data argument

        @param Data
            a list of <type scope="com::sun::star::beans">PropertyValue</type>s
            with information about last opened views to restore it
            <NULL/> isn't allowed here.
	 */
    void setViewData( [in] com::sun::star::container::XIndexAccess Data );
};

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

}; }; }; };

#endif
