Quelle  XText.idl   Sprache: C

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */



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


/** extends a XSimpleText by the capability of inserting
        XTextContents.
 */
published interface XText: com::sun::star::text::XSimpleText
{

    /** inserts a content, such as a text table, text frame or text
        field.

        <p>Which contents are accepted is implementation-specific. Some
        implementations may only accept contents which were created by the
        factory that supplied the same text or the document which contains
        the text.
        </p>

        @param xRange
            specifies the position of insertion. Must belong to this XText.

        @param xContent
            the text content to be inserted.

        @param bAbsorb
            specifies whether the text spanned by <var>xRange</var> will be
            replaced. If `TRUE` then the content of <var>xRange</var> will
            be replaced by <var>xContent</var>, otherwise <var>xContent</var>
            will be inserted at the end of <var>xRange</var>.
     */
    void insertTextContent( [in] com::sun::star::text::XTextRange xRange,
             [in] com::sun::star::text::XTextContent xContent,
             [in] boolean bAbsorb )
            raises( com::sun::star::lang::IllegalArgumentException );


    /** removes the specified content from the text object.
        @param xContent
            the content that is to be removed.
     */
    void removeTextContent( [in] com::sun::star::text::XTextContent xContent )
            raises( com::sun::star::container::NoSuchElementException );

};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */