offapi/com/sun/star/text/TextCursor.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: TextCursor.idl,v $
  10  * $Revision: 1.15.122.1 $
  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_TextCursor_idl__
  31 #define __com_sun_star_text_TextCursor_idl__
  32
  33 #ifndef __com_sun_star_text_TextRange_idl__
  34 #include <com/sun/star/text/TextRange.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_text_XTextCursor_idl__
  38 #include <com/sun/star/text/XTextCursor.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_text_XWordCursor_idl__
  42 #include <com/sun/star/text/XWordCursor.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_text_XSentenceCursor_idl__
  46 #include <com/sun/star/text/XSentenceCursor.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_text_XParagraphCursor_idl__
  50 #include <com/sun/star/text/XParagraphCursor.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_beans_XPropertySet_idl__
  54 #include <com/sun/star/beans/XPropertySet.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_beans_XPropertyState_idl__
  58 #include <com/sun/star/beans/XPropertyState.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_beans_XMultiPropertyStates_idl__
  62 #include <com/sun/star/beans/XMultiPropertyStates.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_document_XDocumentInsertable_idl__
  66 #include <com/sun/star/document/XDocumentInsertable.idl>
  67 #endif
  68
  69 #ifndef __com_sun_star_util_XSortable_idl__
  70 #include <com/sun/star/util/XSortable.idl>
  71 #endif
  72
  73
  74 //=============================================================================
  75
  76  module com {  module sun {  module star {  module text {
  77
  78 //=============================================================================
  79
  80 // DocMerge from xml: service com::sun::star::text::TextCursor
  81 /** A <type>TextCursor</type> is a <type>TextRange</type> which can be moved
  82     within a <type>Text</type> object.
  83     @see TextRange
  84  */
  85 published service TextCursor
  86 {
  87     // DocMerge: empty anyway
  88     service com::sun::star::text::TextRange;
  89
  90     interface com::sun::star::text::XTextCursor;
  91
  92     // DocMerge: empty anyway
  93     [optional] interface com::sun::star::text::XWordCursor;
  94
  95     // DocMerge: empty anyway
  96     [optional] interface com::sun::star::text::XSentenceCursor;
  97
  98     // DocMerge: empty anyway
  99     [optional] interface com::sun::star::text::XParagraphCursor;
 100
 101
 102     // DocMerge from xml: service com::sun::star::text::TextCursor: interface com::sun::star::beans::XPropertySet
 103     /** This interface gives access to the properties of the range that is
 104                 selected by the cursor.
 105      */
 106     interface com::sun::star::beans::XPropertySet;
 107
 108
 109     // DocMerge from xml: service com::sun::star::text::TextCursor: interface com::sun::star::beans::XPropertyState
 110     /** This interface gives access to the state of the properties of the
 111                 range that is selected by the cursor.
 112      */
 113     interface com::sun::star::beans::XPropertyState;
 114     interface com::sun::star::beans::XMultiPropertyStates;
 115
 116
 117     // DocMerge from xml: service com::sun::star::text::TextCursor: interface com::sun::star::document::XDocumentInsertable
 118     /** This optional interface makes it possible to insert a document
 119                 from an external source at the cursor position.
 120      */
 121     [optional] interface com::sun::star::document::XDocumentInsertable;
 122
 123
 124     // DocMerge from xml: service com::sun::star::text::TextCursor: interface com::sun::star::util::XSortable
 125     /** This optional interface makes it possible to sort the contents at
 126                 the cursor position.
 127      */
 128     [optional] interface com::sun::star::util::XSortable;
 129
 130 };
 131
 132 //=============================================================================
 133
 134 }; }; }; };
 135
 136 /*=============================================================================
 137
 138 =============================================================================*/
 139 #endif