offapi/com/sun/star/text/HoriOrientationFormat.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_HoriOrientationFormat_idl__
  28 #define __com_sun_star_text_HoriOrientationFormat_idl__
  29
  30
  31 //=============================================================================
  32
  33  module com {  module sun {  module star {  module text {
  34
  35 //=============================================================================
  36
  37 // DocMerge from xml: struct com::sun::star::text::HoriOrientationFormat
  38 /** describes the horizontal orientation of an object.
  39
  40
  41
  42     <p>If <code>HorizontalOrientation == HORI_NONE</code>, then the value
  43     "XPos" describes the distance from the left border of the context.
  44     Otherwise "XPos" is ignored.
  45
  46     </p>
  47     <p>The following flags are used to adapt the position of the object
  48     to odd and even pages. If "PositionToggle" is set, then the
  49     horizontal position is mirrored.</p>
  50  */
  51 published struct HoriOrientationFormat
  52 {
  53     // DocMerge from xml: field com::sun::star::text::HoriOrientationFormat::XPos
  54     /** contains the distance from the left border. Only valid if
  55         the property HorizontalOrientation contains the value HORI_NONE.
  56      */
  57     long XPos;
  58
  59     //-------------------------------------------------------------------------
  60
  61     // DocMerge from xml: field com::sun::star::text::HoriOrientationFormat::HorizontalOrientation
  62     /** determines the horizontal alignment of an object.
  63         The values refer to com::sun::star::HoriOrientation.
  64      */
  65     short HorizontalOrientation;
  66
  67     //-------------------------------------------------------------------------
  68
  69     // DocMerge from xml: field com::sun::star::text::HoriOrientationFormat::HorizontalRelation
  70     /** determines the reference position of the horizontal alignment.@see com::sun::star::text::RelOrientation
  71      */
  72     short HorizontalRelation;
  73
  74     //-------------------------------------------------------------------------
  75
  76     // DocMerge from xml: field com::sun::star::text::HoriOrientationFormat::PositionToggle
  77     /** determines if the orientation toggles between left and right pages.
  78      */
  79     boolean PositionToggle;
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif