offapi/com/sun/star/text/RelOrientation.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: RelOrientation.idl,v $
  10  * $Revision: 1.12 $
  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_RelOrientation_idl__
  31 #define __com_sun_star_text_RelOrientation_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module text {
  37
  38 //=============================================================================
  39
  40 // DocMerge from idl: constants com::sun::star::text::RelOrientation
  41 /** These values define the reference position of relative orientations.
  42  */
  43 published constants RelOrientation
  44 {
  45     //-------------------------------------------------------------------------
  46
  47     // DocMerge from idl: value com::sun::star::text::RelOrientation::FRAME
  48     /** paragraph, including margins
  49      */
  50     const short FRAME = 0;
  51
  52     //-------------------------------------------------------------------------
  53
  54     // DocMerge from idl: value com::sun::star::text::RelOrientation::PRINT_AREA
  55     /** paragraph, without margins
  56      */
  57     const short PRINT_AREA = 1;
  58
  59     //-------------------------------------------------------------------------
  60
  61     // DocMerge from idl: value com::sun::star::text::RelOrientation::CHAR
  62     /** at a character
  63      */
  64     const short CHAR = 2;
  65
  66     //-------------------------------------------------------------------------
  67
  68     // DocMerge from idl: value com::sun::star::text::RelOrientation::PAGE_LEFT
  69     /** inside the left page margin
  70      */
  71     const short PAGE_LEFT = 3;
  72
  73     //-------------------------------------------------------------------------
  74
  75     // DocMerge from idl: value com::sun::star::text::RelOrientation::PAGE_RIGHT
  76     /** inside the right page margin
  77      */
  78     const short PAGE_RIGHT = 4;
  79
  80     //-------------------------------------------------------------------------
  81
  82     // DocMerge from idl: value com::sun::star::text::RelOrientation::FRAME_LEFT
  83     /** inside the left paragraph margin
  84      */
  85     const short FRAME_LEFT = 5;
  86
  87     //-------------------------------------------------------------------------
  88
  89     // DocMerge from idl: value com::sun::star::text::RelOrientation::FRAME_RIGHT
  90     /** inside the right paragraph margin
  91      */
  92     const short FRAME_RIGHT = 6;
  93
  94     //-------------------------------------------------------------------------
  95
  96     // DocMerge from idl: value com::sun::star::text::RelOrientation::PAGE_FRAME
  97     /** page includes margins for page-anchored frames identical with
  98                 <const>RelOrientation::FRAME</const>
  99      */
 100     const short PAGE_FRAME = 7;
 101
 102     //-------------------------------------------------------------------------
 103
 104     // DocMerge from idl: value com::sun::star::text::RelOrientation::PAGE_PRINT_AREA
 105     /** page without borders (for page anchored frames identical with
 106                 <const>RelOrientation::PRINT_AREA</const>).
 107
 108 <!-- JRH: does not make sense -->
 109      */
 110     const short PAGE_PRINT_AREA = 8;
 111
 112         /** at the top of the text line, only sensible for vertical orientation.
 113
 114             @since OOo 2.0.0
 115          */
 116         const short TEXT_LINE = 9;
 117
 118 };
 119
 120 //=============================================================================
 121
 122 }; }; }; };
 123
 124 #endif