offapi/com/sun/star/text/TextRangeContentProperties.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
  25 /** describes the structural properties to retrieve text contents.
  26
  27     @since OOo 3.3
  28  */
  29 service TextRangeContentProperties
  30 {
  31     /** may contain a document index. */
  32     [optional, readonly, property] com::sun::star::text::XDocumentIndex
  33         DocumentIndex;
  34
  35     /** may contain a text table. */
  36     [optional, readonly, property] com::sun::star::text::XTextTable
  37         TextTable;
  38
  39     /** may contain a table cell. */
  40     [optional, readonly, property] com::sun::star::table::XCell Cell;
  41
  42     /** may contain a text frame. */
  43     [optional, readonly, property] com::sun::star::text::XTextFrame
  44         TextFrame;
  45
  46     /** may contain a text section. */
  47     [optional, readonly, property] com::sun::star::text::XTextSection
  48         TextSection;
  49
  50     /** may contain a document index mark. */
  51     [optional, readonly, property] com::sun::star::text::XDocumentIndexMark
  52         DocumentIndexMark;
  53
  54     /** may contain a reference mark. */
  55     [optional, readonly, property] com::sun::star::text::XTextContent
  56         ReferenceMark;
  57
  58     /** may contain a footnote. */
  59     [optional, readonly, property] com::sun::star::text::XFootnote Footnote;
  60
  61     /** may contain an endnote. */
  62     [optional, readonly, property] com::sun::star::text::XFootnote Endnote;
  63
  64     /** may contain a nested text content.
  65
  66         For example, may contain an InContentMetadata or a
  67         com::sun::star::text::textfield::MetadataField.
  68      */
  69     [optional, readonly, property] com::sun::star::text::XTextContent
  70         NestedTextContent;
  71
  72     /** Paragraph for the start of this range.
  73
  74         @since LibreOffice 6.0
  75      */
  76     [optional, readonly, property] com::sun::star::text::XTextContent TextParagraph;
  77
  78     /** Properties of the linebreak, e.g. for clearing break purposes.
  79
  80         @since LibreOffice 7.4
  81      */
  82     [optional, readonly, property] com::sun::star::text::XTextContent LineBreak;
  83
  84     /** may contain a content control.
  85
  86         @since LibreOffice 7.4
  87      */
  88     [optional, readonly, property] com::sun::star::text::XTextContent ContentControl;
  89
  90 };
  91
  92
  93 }; }; }; };
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */