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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_document_XViewDataSupplier_idl__
  20 #define __com_sun_star_document_XViewDataSupplier_idl__
  21
  22 #include <com/sun/star/container/XIndexAccess.idl>
  23
  24
  25 module com { module sun { module star { module document {
  26
  27 /** gives access to some properties describing all open views to a document
  28
  29     <p>
  30     Each view is described by a sequence< ::com::sun::star::beans::PropertyValue >.
  31     Through this interface the state of all open views can be retrieved and restored
  32     later. These states can also be made persistent so that a document loader can create
  33     all views of the correct types and restore their state to the state when the document was
  34     saved.
  35     </p>
  36  */
  37 published interface XViewDataSupplier: com::sun::star::uno::XInterface
  38 {
  39     /** retrieve information about currently opened view to restore it later
  40
  41         @returns
  42             a com::sun::star::container::XIndexAccess,
  43             that gives access to a list of com::sun::star::beans::PropertyValue
  44             for every open view. May `NULL` if no view is currently available.
  45      */
  46     ::com::sun::star::container::XIndexAccess getViewData();
  47
  48     /** restore all views which will be represented by given data argument
  49
  50         @param Data
  51             a list of com::sun::star::beans::PropertyValues
  52             with information about last opened views to restore it
  53             `NULL` isn't allowed here.
  54      */
  55     void setViewData( [in] com::sun::star::container::XIndexAccess Data );
  56 };
  57
  58
  59 }; }; }; };
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */