1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_document_XViewDataSupplier_idl__
24#define __com_sun_star_document_XViewDataSupplier_idl__
25
26#ifndef __com_sun_star_container_XIndexAccess_idl__
27#include <com/sun/star/container/XIndexAccess.idl>
28#endif
29
30//=============================================================================
31
32module com { module sun { module star { module document {
33
34//=============================================================================
35/** gives access to some properties describing all open views to a document
36
37    <p>
38    Each view is described by a sequence< ::com::sun::star::beans::PropertyValue >.
39    Through this interface the state of all open views can be retrieved and restored
40    later. These states can also be made persistent so that a document loader can create
41    all views of the correct types and restore their state to the state when the document was
42    saved.
43    </p>
44 */
45published interface XViewDataSupplier: com::sun::star::uno::XInterface
46{
47	//-------------------------------------------------------------------------
48    /** retrieve informations about currently opened view to restore it later
49
50        @returns
51            a <type scope="com::sun::star::container">XIndexAccess</type>,
52            that gives access to a list of <type scope="com::sun::star::beans">PropertyValue</type>
53            for every open view. May <NULL/> if no view is currently available.
54	 */
55    ::com::sun::star::container::XIndexAccess getViewData();
56
57	//-------------------------------------------------------------------------
58    /** restore all views which will be represented by given data argument
59
60        @param Data
61            a list of <type scope="com::sun::star::beans">PropertyValue</type>s
62            with information about last opened views to restore it
63            <NULL/> isn't allowed here.
64	 */
65    void setViewData( [in] com::sun::star::container::XIndexAccess Data );
66};
67
68//=============================================================================
69
70}; }; }; };
71
72#endif
73