offapi/com/sun/star/text/TextFrames.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: TextFrames.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_text_TextFrames_idl__
  31 #define __com_sun_star_text_TextFrames_idl__
  32
  33 #ifndef __com_sun_star_container_XNameAccess_idl__
  34 #include <com/sun/star/container/XNameAccess.idl>
  35 #endif
  36 #ifndef __com_sun_star_container_XIndexAccess_idl__
  37 #include <com/sun/star/container/XIndexAccess.idl>
  38 #endif
  39
  40 #ifndef __com_sun_star_container_XContainer_idl__
  41 #include <com/sun/star/container/XContainer.idl>
  42 #endif
  43
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module text {
  48
  49 //=============================================================================
  50
  51 // DocMerge from xml: service com::sun::star::text::TextFrames
  52 /** This is the collection of all <type>TextFrame</type> instances within a
  53     context (e.g. a document).
  54  */
  55 published service TextFrames
  56 {
  57
  58
  59     // DocMerge from xml: service com::sun::star::text::TextFrames: interface com::sun::star::container::XNameAccess
  60     /** This interface makes it possible to access all <type>TextFrame</type>
  61                 instances within this context (e.g. a document) by its name.
  62
  63                 <p>The type of the interfaces returned by this collection is
  64                 always "XTextFrame".
  65      */
  66     interface com::sun::star::container::XNameAccess;
  67     /** This interface makes it possible to access all <type>TextFrame</type>
  68                 instances within this context (e.g. a document) by its index.
  69
  70                 <p>The type of the interfaces returned by this collection is
  71                 always "XTextFrame".
  72      */
  73     interface com::sun::star::container::XIndexAccess;
  74
  75
  76     // DocMerge from xml: service com::sun::star::text::TextFrames: interface com::sun::star::container::XContainer
  77     /** This optional interface makes it possible to register for events
  78                 which occur upon insertion and removal of <type>TextFrame</type>
  79                 instances.
  80      */
  81     [optional] interface com::sun::star::container::XContainer;
  82
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif