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