offapi/com/sun/star/document/XDocumentPropertiesSupplier.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_document_XDocumentPropertiesSupplier_idl__
  20 #define __com_sun_star_document_XDocumentPropertiesSupplier_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/document/XDocumentProperties.idl>
  24
  25
  26 module com {   module sun {   module star {   module document {
  27
  28 /** provides access to the XDocumentProperties instance of a
  29     document.
  30     <p>
  31     A DocumentProperties instance is available on loaded documents
  32     via this supplier interface.
  33     </p>
  34
  35     @since OOo 3.0
  36
  37     @see XDocumentProperties
  38     @see DocumentProperties
  39  */
  40 published interface XDocumentPropertiesSupplier
  41 {
  42     /** provides the document properties object.
  43
  44         @returns
  45             an object of type XDocumentProperties
  46      */
  47     XDocumentProperties getDocumentProperties();
  48 };
  49
  50
  51 }; }; }; };
  52
  53 #endif
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */