xref: /aoo41x/main/offapi/com/sun/star/chart/ChartLegendPosition.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_chart_ChartLegendPosition_idl__
#define __com_sun_star_chart_ChartLegendPosition_idl__


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

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

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

/** specifies one of the default positions of the legend in relation
    to the diagram.
 */
published enum ChartLegendPosition
{
	//-------------------------------------------------------------------------

	/** no chart legend is displayed.

        <p>To disable the legend you should set the property
        <member>ChartDocument::HasLegend</member> to <FALSE/> instead
        of setting this value.</p>
	 */
	NONE,

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

	/** displays the chart legend on the left side of the diagram.

        <p>The second entry in the legend is placed below the first
        one.</p>
	 */
	LEFT,

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

	/** displays the chart legend above the diagram.

        <p>The second entry in the legend is placed an the right hand
        side of the first one.</p>
	 */
	TOP,

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

	/** displays the chart legend on the right side of the diagram.

        <p>The second entry in the legend is placed below the first
        one.</p>
	 */
	RIGHT,

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

	/** displays the chart legend beneath the diagram.

        <p>The second entry in the legend is placed an the right hand
        side of the first one.</p>
	 */
	BOTTOM
};

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

}; }; }; };

#endif