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