offapi/com/sun/star/text/HoriOrientationFormat.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_text_HoriOrientationFormat_idl__
  20 #define __com_sun_star_text_HoriOrientationFormat_idl__
  21
  22
  23
  24  module com {  module sun {  module star {  module text {
  25
  26 /** describes the horizontal orientation of an object.
  27
  28
  29
  30     <p>If <code>HorizontalOrientation == HORI_NONE</code>, then the value
  31     "XPos" describes the distance from the left border of the context.
  32     Otherwise "XPos" is ignored.
  33
  34     </p>
  35     <p>The following flags are used to adapt the position of the object
  36     to odd and even pages. If "PositionToggle" is set, then the
  37     horizontal position is mirrored.</p>
  38  */
  39 published struct HoriOrientationFormat
  40 {
  41     /** contains the distance from the left border. Only valid if
  42         the property HorizontalOrientation contains the value HORI_NONE.
  43      */
  44     long XPos;
  45
  46     /** determines the horizontal alignment of an object.
  47         The values refer to com::sun::star::HoriOrientation.
  48      */
  49     short HorizontalOrientation;
  50
  51     /** determines the reference position of the horizontal alignment.@see com::sun::star::text::RelOrientation
  52      */
  53     short HorizontalRelation;
  54
  55     /** determines if the orientation toggles between left and right pages.
  56      */
  57     boolean PositionToggle;
  58
  59 };
  60
  61
  62 }; }; }; };
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */