offapi/com/sun/star/document/XViewDataSupplier.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XViewDataSupplier.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_document_XViewDataSupplier_idl__
  31 #define __com_sun_star_document_XViewDataSupplier_idl__
  32
  33 #ifndef __com_sun_star_container_XIndexAccess_idl__
  34 #include <com/sun/star/container/XIndexAccess.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module document {
  40
  41 //=============================================================================
  42 /** gives access to some properties describing all open views to a document
  43
  44     <p>
  45     Each view is described by a sequence< ::com::sun::star::beans::PropertyValue >.
  46     Through this interface the state of all open views can be retrieved and restored
  47     later. These states can also be made persistent so that a document loader can create
  48     all views of the correct types and restore their state to the state when the document was
  49     saved.
  50     </p>
  51  */
  52 published interface XViewDataSupplier: com::sun::star::uno::XInterface
  53 {
  54     //-------------------------------------------------------------------------
  55     /** retrieve informations about currently opened view to restore it later
  56
  57         @returns
  58             a <type scope="com::sun::star::container">XIndexAccess</type>,
  59             that gives access to a list of <type scope="com::sun::star::beans">PropertyValue</type>
  60             for every open view. May <NULL/> if no view is currently available.
  61      */
  62     ::com::sun::star::container::XIndexAccess getViewData();
  63
  64     //-------------------------------------------------------------------------
  65     /** restore all views which will be represented by given data argument
  66
  67         @param Data
  68             a list of <type scope="com::sun::star::beans">PropertyValue</type>s
  69             with information about last opened views to restore it
  70             <NULL/> isn't allowed here.
  71      */
  72     void setViewData( [in] com::sun::star::container::XIndexAccess Data );
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif