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
  20
  21
  22  module com {  module sun {  module star {  module text {
  23
  24 /** A TextCursor is a TextRange which can be moved
  25     within a Text object.
  26     @see TextRange
  27  */
  28 published service TextCursor
  29 {
  30     service com::sun::star::text::TextRange;
  31
  32     interface com::sun::star::text::XTextCursor;
  33     [optional] interface com::sun::star::text::XWordCursor;
  34     [optional] interface com::sun::star::text::XSentenceCursor;
  35     [optional] interface com::sun::star::text::XParagraphCursor;
  36
  37     /** This interface gives access to the properties of the range that is
  38                 selected by the cursor.
  39      */
  40     interface com::sun::star::beans::XPropertySet;
  41
  42     /** This interface gives access to the state of the properties of the
  43                 range that is selected by the cursor.
  44      */
  45     interface com::sun::star::beans::XPropertyState;
  46     interface com::sun::star::beans::XMultiPropertyStates;
  47
  48     /** This optional interface makes it possible to insert a document
  49                 from an external source at the cursor position.
  50      */
  51     [optional] interface com::sun::star::document::XDocumentInsertable;
  52
  53     /** This optional interface makes it possible to sort the contents at
  54                 the cursor position.
  55      */
  56     [optional] interface com::sun::star::util::XSortable;
  57
  58 };
  59
  60
  61 }; }; }; };
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */