offapi/com/sun/star/text/RelOrientation.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 /** These values define the reference position of relative orientations.
  25  */
  26 published constants RelOrientation
  27 {
  28     /** paragraph, including margins
  29      */
  30     const short FRAME = 0;
  31
  32     /** paragraph, without margins
  33      */
  34     const short PRINT_AREA = 1;
  35
  36     /** at a character
  37      */
  38     const short CHAR = 2;
  39
  40     /** inside the left page margin
  41      */
  42     const short PAGE_LEFT = 3;
  43
  44     /** inside the right page margin
  45      */
  46     const short PAGE_RIGHT = 4;
  47
  48     /** inside the left paragraph margin
  49      */
  50     const short FRAME_LEFT = 5;
  51
  52     /** inside the right paragraph margin
  53      */
  54     const short FRAME_RIGHT = 6;
  55
  56     /** page includes margins for page-anchored frames identical with
  57                 RelOrientation::FRAME
  58      */
  59     const short PAGE_FRAME = 7;
  60
  61     /** page without borders (for page anchored frames identical with
  62                 RelOrientation::PRINT_AREA).
  63
  64 <!-- JRH: does not make sense -->
  65      */
  66     const short PAGE_PRINT_AREA = 8;
  67
  68         /** at the top of the text line, only sensible for vertical orientation.
  69
  70             @since OOo 2.0
  71          */
  72         const short TEXT_LINE = 9;
  73
  74     /** Bottom page border (page area below PAGE_PRINT_AREA).
  75
  76         @since LibreOffice 7.0
  77      */
  78     const short PAGE_PRINT_AREA_BOTTOM = 10;
  79
  80     /** Top page border (page area above PAGE_PRINT_AREA).
  81
  82         @since LibreOffice 7.1
  83      */
  84     const short PAGE_PRINT_AREA_TOP = 11;
  85
  86 };
  87
  88
  89 }; }; }; };
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */