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