offapi/com/sun/star/text/XTextRangeMover.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: XTextRangeMover.idl,v $
  10  * $Revision: 1.11 $
  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_XTextRangeMover_idl__
  31 #define __com_sun_star_text_XTextRangeMover_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_text_XTextRange_idl__
  38 #include <com/sun/star/text/XTextRange.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module text {
  45
  46 //=============================================================================
  47
  48 // DocMerge from xml: interface com::sun::star::text::XTextRangeMover
  49 /** makes it possible to move a text range (e.g. a paragraph by itself)
  50     within this text.
  51
  52
  53
  54     <p>The movement is specified by the number of paragraphs within the order
  55     of paragraphs.
  56
  57     </p>@see Text
  58  */
  59 published interface XTextRangeMover: com::sun::star::uno::XInterface
  60 {
  61     //-------------------------------------------------------------------------
  62
  63     // DocMerge from xml: method com::sun::star::text::XTextRangeMover::moveTextRange
  64     /** moves the contents to which <var>xRange</var> refers forward or
  65         backward.
  66      */
  67     void moveTextRange( [in] com::sun::star::text::XTextRange xRange,
  68              [in] short nParagraphs );
  69
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif