offapi/com/sun/star/text/XRelativeTextContentRemove.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: XRelativeTextContentRemove.idl,v $
  10  * $Revision: 1.10 $
  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_XRelativeTextContentRemove_idl__
  31 #define __com_sun_star_text_XRelativeTextContentRemove_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  37 #include <com/sun/star/lang/IllegalArgumentException.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42  module com {  module sun {  module star {  module text {
  43
  44  published interface XTextContent;
  45
  46 // DocMerge from xml: interface com::sun::star::text::XRelativeTextContentRemove
  47 /** makes it possible to remove text contents before or
  48     after existing text contents.
  49
  50
  51
  52
  53
  54
  55
  56     @deprecated
  57  */
  58 published interface XRelativeTextContentRemove: com::sun::star::uno::XInterface
  59 {
  60     //-------------------------------------------------------------------------
  61
  62     // DocMerge from xml: method com::sun::star::text::XRelativeTextContentRemove::removeTextContentBefore
  63     /** removes the text content that preceeds the argument.
  64
  65         <p> This is helpful to remove empty paragraphs before text tables. </p>
  66      */
  67     void removeTextContentBefore(
  68             [in] XTextContent xSuccessor )
  69         raises( com::sun::star::lang::IllegalArgumentException );
  70     //-------------------------------------------------------------------------
  71
  72     // DocMerge from xml: method com::sun::star::text::XRelativeTextContentRemove::removeTextContentAfter
  73     /** removes the text content that follows the argument.
  74
  75         <p> This is helpful to remove empty paragraphs followin text tables espacially in
  76         headers, footers or text frames. </p>
  77      */
  78     void removeTextContentAfter(
  79             [in] XTextContent xPredecessor )
  80         raises( com::sun::star::lang::IllegalArgumentException );
  81 };
  82 };};};};
  83
  84 #endif
  85