offapi/com/sun/star/chart/XDiagramPositioning.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDiagramPositioning.idl,v $
  10  * $Revision: 1.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_chart_XDiagramPositioning_idl__
  31 #define __com_sun_star_chart_XDiagramPositioning_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36 #ifndef __com_sun_star_awt_Rectangle_idl__
  37 #include <com/sun/star/awt/Rectangle.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42  module com {  module sun {  module star {  module chart {
  43
  44 //=============================================================================
  45
  46 /** allow for different positioning options for a diagram
  47
  48     @see Diagram
  49  */
  50 interface XDiagramPositioning : com::sun::star::uno::XInterface
  51 {
  52     /** the diagram will be placed automtically
  53     */
  54     void setAutomaticDiagramPositioning();
  55
  56     /** @returns whether the diagram is placed automtically
  57     */
  58     boolean isAutomaticDiagramPositioning();
  59
  60     /** place the inner diagram part excluding any axes, labels and titles
  61         @param PositionRect
  62             specifies the position and size in 100/th mm
  63     */
  64     void setDiagramPositionExcludingAxes( [in] com::sun::star::awt::Rectangle PositionRect );
  65
  66     /** @returns true in case the diagram position was set with method setDiagramPositionExcludingAxes
  67     */
  68     boolean isExcludingDiagramPositioning();
  69
  70     /** @returns the position rectangle of the inner diagram part excluding any axes, labels and titles.
  71         Position and size are given in 100/th mm.
  72         It might be necessary to calculate the positioning so this method can be expensive and the result may depend on different other settings.
  73     */
  74     com::sun::star::awt::Rectangle calculateDiagramPositionExcludingAxes();
  75
  76
  77     /** place the outer diagram part including the axes and axes labels, but excluding the axes titles.
  78         @param PositionRect
  79             specifies the position and size in 100/th mm
  80     */
  81     void setDiagramPositionIncludingAxes( [in] com::sun::star::awt::Rectangle PositionRect );
  82
  83     /** @returns the position rectangle of the diagram including the axes and axes labels, but excluding the axes titles.
  84         Position and size are given in 100/th mm.
  85         It might be necessary to calculate the positioning so this method can be expensive and the result may depend on different other settings.
  86     */
  87     com::sun::star::awt::Rectangle calculateDiagramPositionIncludingAxes();
  88
  89     /** place the diagram including the axes, axes labels and axes titles.
  90         For the placement the current axis titles are taken into account, so the titles must be initialized properly before this method is called.
  91         @param PositionRect
  92             specifies the position and size in 100/th mm
  93     */
  94     void setDiagramPositionIncludingAxesAndAxisTitles( [in] com::sun::star::awt::Rectangle PositionRect );
  95
  96     /** @returns the position rectangle of the diagram including the axes, axes labels and axes titles.
  97         Position and size are given in 100/th mm.
  98         It might be necessary to calculate the positioning so this method can be expensive and the result may depend on different other settings.
  99     */
 100     com::sun::star::awt::Rectangle calculateDiagramPositionIncludingAxesAndAxisTitles();
 101 };
 102
 103 //=============================================================================
 104
 105 }; }; }; };
 106
 107 #endif