xref: /trunk/main/offapi/com/sun/star/chart/ChartDocument.idl (revision 0d3a54ff)

/**************************************************************
 *
 * 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_chart_ChartDocument_idl__
#define __com_sun_star_chart_ChartDocument_idl__

#ifndef __com_sun_star_chart_XChartDocument_idl__
#include <com/sun/star/chart/XChartDocument.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
#include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
#endif

#include <com/sun/star/drawing/XDrawPageSupplier.idl>


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

 module com {  module sun {  module star {  module chart {

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

/** is the service for a chart document.

	<p>A chart document consists of a reference to the data source,
	the diagram and some additional elements like a main title, a
	sub-title or a legend.

	</p>@see Diagram
		@see ChartLegend
		@see ChartTitle
		@see ChartDataArray
 */
published service ChartDocument
{
    /** If a <type>ChartDocument</type> may be stored as XML file,
        this service should be supported in order to preserve unparsed
        XML attributes.

	@since OpenOffice 1.1.2
     */
    [optional] service ::com::sun::star::xml::UserDefinedAttributeSupplier;

    interface ::com::sun::star::chart::XChartDocument;
	interface ::com::sun::star::beans::XPropertySet;

    [optional] interface ::com::sun::star::drawing::XDrawPageSupplier;

	//-------------------------------------------------------------------------

	/** determines if the main title is shown or hidden.
	 */
	[property] boolean HasMainTitle;

	//-------------------------------------------------------------------------

	/** determines if the subtitle is shown or hidden.
	 */
	[property] boolean HasSubTitle;

	//-------------------------------------------------------------------------

	/** determines if the legend is shown or hidden.
	 */
	[property] boolean HasLegend;
};

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

}; }; }; };

#endif