xref: /aoo41x/main/offapi/com/sun/star/document/XDocumentInfoSupplier.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_document_XDocumentInfoSupplier_idl__
#define __com_sun_star_document_XDocumentInfoSupplier_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_document_XDocumentInfo_idl__
#include <com/sun/star/document/XDocumentInfo.idl>
#endif

//=============================================================================

module com {   module sun {   module star {   module document {

//=============================================================================
/** through this interface documents can provide a <type>DocumentInfo</type>

    <p>
    A <type>DocumentInfo</type> is available on already opened documents only
    and must be provides by this supplier interface.
    Instead of that you can use the service <type>StandaloneDocumentInfo</type>
    to have access to such informations without opening the whole file.
    It read/write parts of the document, which include the required informations,
    only.
    </p>

    @deprecated     Use <type>XDocumentPropertiesSupplier</type> instead.

    @see DocumentInfo
    @see StandaloneDocumentInfo
 */
published interface XDocumentInfoSupplier: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
    /** provides the document information object

        @returns
            an object of type <type>DocumentInfo</type>
	 */
    XDocumentInfo getDocumentInfo();
};

//=============================================================================

}; }; }; };

#endif