offapi/com/sun/star/document/XRedlinesSupplier.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: XRedlinesSupplier.idl,v $
  10  * $Revision: 1.8 $
  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_XRedlinesSupplier_idl__
  31 #define __com_sun_star_document_XRedlinesSupplier_idl__
  32
  33 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  34 #include <com/sun/star/container/XEnumerationAccess.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {   module sun {   module star {   module document {
  40
  41 //=============================================================================
  42
  43 /** provides access to a container of the redline objects of the document.
  44  */
  45 published interface XRedlinesSupplier: com::sun::star::uno::XInterface
  46 {
  47     //-------------------------------------------------------------------------
  48     /** @returns
  49             an enumeration access that provides access to the redline objects of the document.
  50
  51             <p>The returned objects implent at least the interface
  52             <type scope="com::sun::star::beans">XPropertySet</type>.
  53             Specific objects may support other interfaces as well.</p>
  54      */
  55     com::sun::star::container::XEnumerationAccess getRedlines();
  56 };
  57
  58 //=============================================================================
  59
  60 }; }; }; };
  61
  62 #endif
  63