xref: /trunk/main/offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl (revision 34c958ab)

/**************************************************************
 *
 * 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_XDocumentPropertiesSupplier_idl__
#define __com_sun_star_document_XDocumentPropertiesSupplier_idl__

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

#ifndef __com_sun_star_document_XDocumentProperties_idl__
#include <com/sun/star/document/XDocumentProperties.idl>
#endif

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

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

//=============================================================================
/** provides access to the <type>XDocumentProperties</type> instance of a
    document.
    <p>
    A <type>DocumentProperties</type> instance is available on loaded documents
    via this supplier interface.
    </p>

    @since OpenOffice 3.0

    @see XDocumentProperties
    @see DocumentProperties
 */
published interface XDocumentPropertiesSupplier
{
	//-------------------------------------------------------------------------
    /** provides the document properties object.

        @returns
            an object of type <type>XDocumentProperties</type>
	 */
    XDocumentProperties getDocumentProperties();
};

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

}; }; }; };

#endif