xref: /AOO41X/main/offapi/com/sun/star/text/TextFrames.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_text_TextFrames_idl__
#define __com_sun_star_text_TextFrames_idl__

#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif
#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

#ifndef __com_sun_star_container_XContainer_idl__
#include <com/sun/star/container/XContainer.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

// DocMerge from xml: service com::sun::star::text::TextFrames
/** This is the collection of all <type>TextFrame</type> instances within a
    context (e.g. a document).
 */
published service TextFrames
{


    // DocMerge from xml: service com::sun::star::text::TextFrames: interface com::sun::star::container::XNameAccess
    /** This interface makes it possible to access all <type>TextFrame</type>
                instances within this context (e.g. a document) by its name.

                <p>The type of the interfaces returned by this collection is
                always "XTextFrame".
     */
    interface com::sun::star::container::XNameAccess;
    /** This interface makes it possible to access all <type>TextFrame</type>
                instances within this context (e.g. a document) by its index.

                <p>The type of the interfaces returned by this collection is
                always "XTextFrame".
     */
    interface com::sun::star::container::XIndexAccess;


    // DocMerge from xml: service com::sun::star::text::TextFrames: interface com::sun::star::container::XContainer
    /** This optional interface makes it possible to register for events
                which occur upon insertion and removal of <type>TextFrame</type>
                instances.
     */
    [optional] interface com::sun::star::container::XContainer;

};

//=============================================================================

}; }; }; };

#endif