offapi/com/sun/star/rendering/XIntegerBitmap.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_rendering_XIntegerBitmap_idl__
  20 #define __com_sun_star_rendering_XIntegerBitmap_idl__
  21
  22 #include <com/sun/star/lang/IllegalArgumentException.idl>
  23 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  24 #include <com/sun/star/geometry/IntegerPoint2D.idl>
  25 #include <com/sun/star/geometry/IntegerRectangle2D.idl>
  26 #include <com/sun/star/rendering/IntegerBitmapLayout.idl>
  27 #include <com/sun/star/rendering/XIntegerReadOnlyBitmap.idl>
  28
  29
  30 module com { module sun { module star { module rendering {
  31
  32 /** This is a specialized interface for bitmaps having integer color
  33     channels.<p>
  34
  35     @since OOo 2.0
  36  */
  37 interface XIntegerBitmap : XIntegerReadOnlyBitmap
  38 {
  39
  40     /** Set raw data of a bitmap.<p>
  41
  42         Set raw data of a bitmap, in the format as defined by
  43         getMemoryLayout(). With the given rectangle, a subset of the
  44         bitmap can be changed. If the internal data format's pixel are
  45         not integer multiples of bytes (i.e. if one pixel occupies
  46         less than a byte), the leftover content of the bytes at the
  47         right of each scanline is ignored and left unchanged in the
  48         bitmap. When setting subsets of the bitmap, the same scanline
  49         padding takes place as when the whole bitmap is changed.<p>
  50
  51         When setting data on volatile bitmaps, always call isValid()
  52         before, and retrieve a new memory layout via
  53         getMemoryLayout(). At least under Windows, the memory layout
  54         can change for the same bitmap, if the user e.g. switches the
  55         screen resolution. Thus, this method will throw an
  56         IllegalArgumentException, if the memory layout changed between
  57         a call to getMemoryLayout() and setData().
  58
  59         @param data
  60         Data to set
  61
  62         @param bitmapLayout
  63         Layout of the data to set. Must match this bitmap's current
  64         layout.
  65
  66         @param rect
  67         Destination rectangle, within the bounds of the bitmap, to set
  68         the data in.
  69
  70         @throws com::sun::star::lang::IndexOutOfBoundsException
  71         if parts of the given rectangle are outside the permissible
  72         bitmap area.
  73
  74         @throws com::sun::star::lang::IllegalArgumentException
  75         if the given memory layout does not match this bitmap's
  76         layout, or if the given data sequence has too few or too many
  77         elements.
  78      */
  79     void                setData( [in] sequence<byte> data, [in] IntegerBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerRectangle2D rect )
  80         raises (com::sun::star::lang::IllegalArgumentException,
  81                 com::sun::star::lang::IndexOutOfBoundsException);
  82
  83
  84     /** Set a single pixel of the bitmap with the given color
  85         value.<p>
  86
  87         If the internal data format's pixel are not integer multiples
  88         of bytes (i.e. if one pixel occupies less than a byte), the
  89         color value is expected in the least significant bits of the
  90         single byte given as the color.<p>
  91
  92         When setting data on volatile bitmaps, always call isValid()
  93         before, and retrieve a new memory layout via
  94         getMemoryLayout(). At least under Windows, the memory layout
  95         can change for the same bitmap, if the user e.g. switches the
  96         screen resolution. Thus, this method will throw an
  97         IllegalArgumentException, if the memory layout changed between
  98         a call to getMemoryLayout() and setPixel().
  99
 100         @param color
 101         The color value(s) to set
 102
 103         @param bitmapLayout
 104         Layout of the color elements to set. Must match this bitmap's
 105         current layout.
 106
 107         @param pos
 108         Pixel position with the bounds of the bitmap to set.
 109
 110         @throws com::sun::star::lang::IndexOutOfBoundsException
 111         if the given point is outside the permissible bitmap area.
 112
 113         @throws com::sun::star::lang::IllegalArgumentException
 114         if the given memory layout does not match this bitmap's
 115         layout, or if the given data sequence has too few or too many
 116         elements.
 117      */
 118     void                setPixel( [in] sequence<byte> color, [in] IntegerBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos )
 119         raises (com::sun::star::lang::IllegalArgumentException,
 120                 com::sun::star::lang::IndexOutOfBoundsException);
 121 };
 122
 123 }; }; }; };
 124
 125 #endif
 126
 127 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */