offapi/com/sun/star/text/XDocumentIndex.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 /** This is the main interface for a document index.
  25
  26
  27
  28     <p>Use com::sun::star::util::XRefreshable and
  29     com::sun::star::lang::XServiceInfo instead, if available.
  30
  31     </p>
  32
  33
  34
  35
  36
  37
  38     @deprecated
  39     @see com::sun::star::util::XRefreshable
  40     @see com::sun::star::lang::XServiceInfo
  41  */
  42 published interface XDocumentIndex: com::sun::star::text::XTextContent
  43 {
  44     /** returns the service name that was used to create this document index type.
  45      */
  46     string getServiceName();
  47
  48     /** initiates an update to the document index.
  49      */
  50     void update();
  51
  52 };
  53
  54
  55 }; }; }; };
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */