1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_chart_XDiagramPositioning_idl__
24#define __com_sun_star_chart_XDiagramPositioning_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29#ifndef __com_sun_star_awt_Rectangle_idl__
30#include <com/sun/star/awt/Rectangle.idl>
31#endif
32
33//=============================================================================
34
35 module com {  module sun {  module star {  module chart {
36
37//=============================================================================
38
39/** allow for different positioning options for a diagram
40
41    @see Diagram
42 */
43interface XDiagramPositioning : com::sun::star::uno::XInterface
44{
45    /** the diagram will be placed automtically
46    */
47    void setAutomaticDiagramPositioning();
48
49    /** @returns whether the diagram is placed automtically
50    */
51    boolean isAutomaticDiagramPositioning();
52
53    /** place the inner diagram part excluding any axes, labels and titles
54        @param PositionRect
55            specifies the position and size in 100/th mm
56    */
57    void setDiagramPositionExcludingAxes( [in] com::sun::star::awt::Rectangle PositionRect );
58
59    /** @returns true in case the diagram position was set with method setDiagramPositionExcludingAxes
60    */
61    boolean isExcludingDiagramPositioning();
62
63    /** @returns the position rectangle of the inner diagram part excluding any axes, labels and titles.
64        Position and size are given in 100/th mm.
65        It might be necessary to calculate the positioning so this method can be expensive and the result may depend on different other settings.
66    */
67    com::sun::star::awt::Rectangle calculateDiagramPositionExcludingAxes();
68
69
70    /** place the outer diagram part including the axes and axes labels, but excluding the axes titles.
71        @param PositionRect
72            specifies the position and size in 100/th mm
73    */
74    void setDiagramPositionIncludingAxes( [in] com::sun::star::awt::Rectangle PositionRect );
75
76    /** @returns the position rectangle of the diagram including the axes and axes labels, but excluding the axes titles.
77        Position and size are given in 100/th mm.
78        It might be necessary to calculate the positioning so this method can be expensive and the result may depend on different other settings.
79    */
80    com::sun::star::awt::Rectangle calculateDiagramPositionIncludingAxes();
81
82    /** place the diagram including the axes, axes labels and axes titles.
83        For the placement the current axis titles are taken into account, so the titles must be initialized properly before this method is called.
84        @param PositionRect
85            specifies the position and size in 100/th mm
86    */
87    void setDiagramPositionIncludingAxesAndAxisTitles( [in] com::sun::star::awt::Rectangle PositionRect );
88
89    /** @returns the position rectangle of the diagram including the axes, axes labels and axes titles.
90        Position and size are given in 100/th mm.
91        It might be necessary to calculate the positioning so this method can be expensive and the result may depend on different other settings.
92    */
93    com::sun::star::awt::Rectangle calculateDiagramPositionIncludingAxesAndAxisTitles();
94};
95
96//=============================================================================
97
98}; }; }; };
99
100#endif
101