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