offapi/com/sun/star/text/GraphicCrop.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_GraphicCrop_idl__
  20 #define __com_sun_star_text_GraphicCrop_idl__
  21
  22
  23
  24  module com {  module sun {  module star {  module text {
  25
  26 /** describes the cropping of graphic objects.
  27     Cropping means to show only parts of the object.
  28
  29
  30
  31     <p>Negative values cut the visible area; positive values
  32     extend the visible area by filling it with background color.
  33     The absolute sum of top and bottom crop must be smaller
  34     than the objects original height.  The absolute sum of the left and
  35     right crop must be smaller than the object's original width.
  36
  37     </p>
  38     <p>If this property is applied to a graphic object, then this object
  39     will correct these values if necessary.
  40     </p>
  41  */
  42 published struct GraphicCrop
  43 {
  44     /** contains the top value to cut (if negative) or to extend (if positive)
  45      */
  46     long Top;
  47
  48     /** contains the bottom value to cut (if negative) or to extend (if positive)
  49      */
  50     long Bottom;
  51
  52     /** contains the left value to cut (if negative) or to extend (if positive)
  53      */
  54     long Left;
  55
  56     /** contains the right value to cut (if negative) or to extend (if positive)
  57      */
  58     long Right;
  59
  60 };
  61
  62
  63 }; }; }; };
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */