xref: /trunk/main/offapi/com/sun/star/chart2/FillBitmap.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef com_sun_star_chart2_FillBitmap_idl
#define com_sun_star_chart2_FillBitmap_idl

// #ifndef __com_sun_star_awt_XBitmap_idl__
// #include <com/sun/star/awt/XBitmap.idl>
// #endif

#ifndef __com_sun_star_awt_Point_idl__
#include <com/sun/star/awt/Point.idl>
#endif
#ifndef __com_sun_star_awt_Size_idl__
#include <com/sun/star/awt/Size.idl>
#endif

#ifndef __com_sun_star_drawing_BitmapMode_idl__
#include <com/sun/star/drawing/BitmapMode.idl>
#endif
#ifndef __com_sun_star_drawing_RectanglePoint_idl__
#include <com/sun/star/drawing/RectanglePoint.idl>
#endif


module com
{
module sun
{
module star
{
module chart2
{

/** This structure contains all properties of a bitmap when used as
    FillStyle.

    @see com::sun::star::drawing::FillProperties
  */
struct FillBitmap
{
    /** a URL to the bitmap used.  This may be an internal URL of the
        graphics manager.
    */
    string aURL;

    /** This is the horizontal and vertical offset where the tile
        starts.

        <p>It is given in percent in relation to the width of the
        bitmap.</p>
    */
    com::sun::star::awt::Point aOffset;

    /** Every second line (X) / row (Y) of tiles is moved the given
        percent of the width of the bitmap.
    */
    com::sun::star::awt::Point aPositionOffset;

    /** The RectanglePoint specifies the position inside of the bitmap
        to use as the top left position for rendering.
    */
    com::sun::star::drawing::RectanglePoint aRectanglePoint;

    /** specifies if the size is given in percentage or as an absolute
        value.

        <p>If this is <TRUE/>, the properties SizeX and
        SizeY contain the size of the tile in percent of the
        size of the original bitmap. If this is <FALSE/>, the size of
        the tile is specified with 1/100th mm.</p>
    */
    boolean bLogicalSize;

    /** This is the size of the tile for filling.

        <p>Depending on the property LogicalSize, this is
        either relative or absolute.</p>
    */
    com::sun::star::awt::Size aSize;

    /** this enum selects how a area is filled with a single bitmap.

        <p>It may be repeated, stretched or displayed with blank space
        around it.</p>
    */
    com::sun::star::drawing::BitmapMode aBitmapMode;
};

} ; // chart2
} ; // com
} ; // sun
} ; // star


#endif