offapi/com/sun/star/text/GraphicCrop.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: GraphicCrop.idl,v $
  10  * $Revision: 1.10 $
  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_GraphicCrop_idl__
  31 #define __com_sun_star_text_GraphicCrop_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module text {
  37
  38 //=============================================================================
  39
  40 // DocMerge from xml: struct com::sun::star::text::GraphicCrop
  41 /** describes the cropping of graphic objects.
  42     Cropping means to show only parts of the object.
  43
  44
  45
  46     <p>Negative values cut the visible area; positive values
  47     extend the visible area by filling it with background color.
  48     The absolute sum of top and bottom crop must be smaller
  49     than the objects original height.  The absolute sum of the left and
  50     right crop must be smaller than the object's original width.
  51
  52     </p>
  53     <p>If this property is applied to a graphic object, then this object
  54     will correct these values if necessary.
  55     </p>
  56  */
  57 published struct GraphicCrop
  58 {
  59     // DocMerge from xml: field com::sun::star::text::GraphicCrop::Top
  60     /** contains the top value to cut (if negative) or to extend (if positive)
  61      */
  62     long Top;
  63
  64     //-------------------------------------------------------------------------
  65
  66     // DocMerge from xml: field com::sun::star::text::GraphicCrop::Bottom
  67     /** contains the bottom value to cut (if negative) or to extend (if positive)
  68      */
  69     long Bottom;
  70
  71     //-------------------------------------------------------------------------
  72
  73     // DocMerge from xml: field com::sun::star::text::GraphicCrop::Left
  74     /** contains the left value to cut (if negative) or to extend (if positive)
  75      */
  76     long Left;
  77
  78     //-------------------------------------------------------------------------
  79
  80     // DocMerge from xml: field com::sun::star::text::GraphicCrop::Right
  81     /** contains the right value to cut (if negative) or to extend (if positive)
  82      */
  83     long Right;
  84
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; };
  90
  91 #endif