offapi/com/sun/star/text/VertOrientationFormat.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: VertOrientationFormat.idl,v $
  10  * $Revision: 1.9 $
  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_text_VertOrientationFormat_idl__
  31 #define __com_sun_star_text_VertOrientationFormat_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module text {
  37
  38 //=============================================================================
  39
  40 // DocMerge from xml: struct com::sun::star::text::VertOrientationFormat
  41 /** describes the vertical orientation of an object.
  42
  43
  44
  45     <p>If <code>VerticalOrientation == VERT_NONE</code>, then the value "YPos"
  46     describes the distance from the top of the context. Otherwise "YPos"
  47     is ignored.
  48     </p>
  49  */
  50 published struct VertOrientationFormat
  51 {
  52     // DocMerge from xml: field com::sun::star::text::VertOrientationFormat::YPos
  53     /** contains the distance from top. Only valid if the property
  54         VerticalOrientation contains the value VERT_NONE.
  55      */
  56     long YPos;
  57
  58     //-------------------------------------------------------------------------
  59
  60     // DocMerge from xml: field com::sun::star::text::VertOrientationFormat::VerticalOrientation
  61     /** determines the vertical alignment of an object.
  62         The values refer to com::sun::star::VertOrientation.
  63      */
  64     short VerticalOrientation;
  65
  66     //-------------------------------------------------------------------------
  67
  68     // DocMerge from xml: field com::sun::star::text::VertOrientationFormat::VerticalRelation
  69     /** determines the reference position of the vertical alignment.@see com::sun::star::text::RelOrientation
  70      */
  71     short VerticalRelation;
  72
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79
  80 #endif