offapi/com/sun/star/text/TextCursor.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_TextCursor_idl__
  20 #define __com_sun_star_text_TextCursor_idl__
  21
  22 #include <com/sun/star/text/TextRange.idl>
  23 #include <com/sun/star/text/XTextCursor.idl>
  24 #include <com/sun/star/text/XWordCursor.idl>
  25 #include <com/sun/star/text/XSentenceCursor.idl>
  26 #include <com/sun/star/text/XParagraphCursor.idl>
  27 #include <com/sun/star/beans/XPropertySet.idl>
  28 #include <com/sun/star/beans/XPropertyState.idl>
  29 #include <com/sun/star/beans/XMultiPropertyStates.idl>
  30 #include <com/sun/star/document/XDocumentInsertable.idl>
  31 #include <com/sun/star/util/XSortable.idl>
  32
  33
  34
  35  module com {  module sun {  module star {  module text {
  36
  37 /** A TextCursor is a TextRange which can be moved
  38     within a Text object.
  39     @see TextRange
  40  */
  41 published service TextCursor
  42 {
  43     service com::sun::star::text::TextRange;
  44
  45     interface com::sun::star::text::XTextCursor;
  46     [optional] interface com::sun::star::text::XWordCursor;
  47     [optional] interface com::sun::star::text::XSentenceCursor;
  48     [optional] interface com::sun::star::text::XParagraphCursor;
  49
  50     /** This interface gives access to the properties of the range that is
  51                 selected by the cursor.
  52      */
  53     interface com::sun::star::beans::XPropertySet;
  54
  55     /** This interface gives access to the state of the properties of the
  56                 range that is selected by the cursor.
  57      */
  58     interface com::sun::star::beans::XPropertyState;
  59     interface com::sun::star::beans::XMultiPropertyStates;
  60
  61     /** This optional interface makes it possible to insert a document
  62                 from an external source at the cursor position.
  63      */
  64     [optional] interface com::sun::star::document::XDocumentInsertable;
  65
  66     /** This optional interface makes it possible to sort the contents at
  67                 the cursor position.
  68      */
  69     [optional] interface com::sun::star::util::XSortable;
  70
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */