offapi/com/sun/star/text/HoriOrientationFormat.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: HoriOrientationFormat.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_HoriOrientationFormat_idl__
  31 #define __com_sun_star_text_HoriOrientationFormat_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::HoriOrientationFormat
  41 /** describes the horizontal orientation of an object.
  42
  43
  44
  45     <p>If <code>HorizontalOrientation == HORI_NONE</code>, then the value
  46     "XPos" describes the distance from the left border of the context.
  47     Otherwise "XPos" is ignored.
  48
  49     </p>
  50     <p>The following flags are used to adapt the position of the object
  51     to odd and even pages. If "PositionToggle" is set, then the
  52     horizontal position is mirrored.</p>
  53  */
  54 published struct HoriOrientationFormat
  55 {
  56     // DocMerge from xml: field com::sun::star::text::HoriOrientationFormat::XPos
  57     /** contains the distance from the left border. Only valid if
  58         the property HorizontalOrientation contains the value HORI_NONE.
  59      */
  60     long XPos;
  61
  62     //-------------------------------------------------------------------------
  63
  64     // DocMerge from xml: field com::sun::star::text::HoriOrientationFormat::HorizontalOrientation
  65     /** determines the horizontal alignment of an object.
  66         The values refer to com::sun::star::HoriOrientation.
  67      */
  68     short HorizontalOrientation;
  69
  70     //-------------------------------------------------------------------------
  71
  72     // DocMerge from xml: field com::sun::star::text::HoriOrientationFormat::HorizontalRelation
  73     /** determines the reference position of the horizontal alignment.@see com::sun::star::text::RelOrientation
  74      */
  75     short HorizontalRelation;
  76
  77     //-------------------------------------------------------------------------
  78
  79     // DocMerge from xml: field com::sun::star::text::HoriOrientationFormat::PositionToggle
  80     /** determines if the orientation toggles between left and right pages.
  81      */
  82     boolean PositionToggle;
  83
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 #endif