offapi/com/sun/star/text/XDocumentIndexMark.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_XDocumentIndexMark_idl__
  20 #define __com_sun_star_text_XDocumentIndexMark_idl__
  21
  22 #include <com/sun/star/text/XTextContent.idl>
  23
  24
  25
  26  module com {  module sun {  module star {  module text {
  27
  28 /** gives access to the mark of a document index entry.@see DocumentIndexMark
  29  */
  30 published interface XDocumentIndexMark: com::sun::star::text::XTextContent
  31 {
  32     /** @returns
  33                 the explicitly set string for the index mark.
  34
  35          @see setMarkEntry
  36      */
  37     string getMarkEntry();
  38
  39     /** sets an explicit string for this index mark to use
  40         in the index.
  41
  42
  43
  44         <p>If empty, the string of the TextRange to which
  45         the TextContent refers is used in the index.</p>
  46      */
  47     void setMarkEntry( [in] string aIndexEntry );
  48
  49 };
  50
  51
  52 }; }; }; };
  53
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */