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_document_XViewDataSupplier_idl__
28#define __com_sun_star_document_XViewDataSupplier_idl__
29
30#ifndef __com_sun_star_container_XIndexAccess_idl__
31#include <com/sun/star/container/XIndexAccess.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module document {
37
38//=============================================================================
39/** gives access to some properties describing all open views to a document
40
41    <p>
42    Each view is described by a sequence< ::com::sun::star::beans::PropertyValue >.
43    Through this interface the state of all open views can be retrieved and restored
44    later. These states can also be made persistent so that a document loader can create
45    all views of the correct types and restore their state to the state when the document was
46    saved.
47    </p>
48 */
49published interface XViewDataSupplier: com::sun::star::uno::XInterface
50{
51	//-------------------------------------------------------------------------
52    /** retrieve informations about currently opened view to restore it later
53
54        @returns
55            a <type scope="com::sun::star::container">XIndexAccess</type>,
56            that gives access to a list of <type scope="com::sun::star::beans">PropertyValue</type>
57            for every open view. May <NULL/> if no view is currently available.
58	 */
59    ::com::sun::star::container::XIndexAccess getViewData();
60
61	//-------------------------------------------------------------------------
62    /** restore all views which will be represented by given data argument
63
64        @param Data
65            a list of <type scope="com::sun::star::beans">PropertyValue</type>s
66            with information about last opened views to restore it
67            <NULL/> isn't allowed here.
68	 */
69    void setViewData( [in] com::sun::star::container::XIndexAccess Data );
70};
71
72//=============================================================================
73
74}; }; }; };
75
76#endif
77