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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_chart_ChartTitle_idl__
  20 #define __com_sun_star_chart_ChartTitle_idl__
  21
  22 #include <com/sun/star/drawing/Shape.idl>
  23 #include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
  24
  25
  26  module com {  module sun {  module star {  module chart {
  27
  28
  29 /** specifies titles in a chart.
  30
  31     <p>In a chart there may be the following titles: the main title,
  32     the sub title, and axis titles of the x- and y-axis.</p>
  33  */
  34 published service ChartTitle
  35 {
  36     service com::sun::star::drawing::Shape;
  37
  38
  39     /** If this property is `TRUE` the position is calculated by the application automatically.
  40         Setting this property to false will have no effect. Instead use the interface com::sun::star::drawing::XShape
  41         to set a concrete position.
  42      */
  43     [optional, property] boolean AutomaticPosition;
  44
  45
  46     /** If a ChartTitle may be stored as XML element,
  47         this service should be supported in order to preserve unparsed
  48         XML attributes.
  49
  50     @since OOo 1.1.2
  51      */
  52     [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
  53
  54
  55     /** specifies the rotation of the shape in 100th of degrees.
  56
  57         <p>Especially in three-dimensional charts, this property comes
  58         in handy if you want to align the axis titles with the axis,
  59         which are usually not vertical or horizontal in the
  60         two-dimensional projection.</p>
  61      */
  62     [property] long TextRotation;
  63
  64
  65     /** contains the text of the title.
  66
  67         <p>Note that you cannot change attributes of parts of a
  68         title, e.g., put one word in bold characters.  All formatting
  69         affects the entire string.</p>
  70      */
  71     [property] string String;
  72
  73 };
  74
  75
  76 }; }; }; };
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */