/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_text_TextGraphicObject_idl__
#define __com_sun_star_text_TextGraphicObject_idl__

#include <com/sun/star/text/BaseFrame.idl>
#include <com/sun/star/text/GraphicCrop.idl>
#include <com/sun/star/drawing/PointSequenceSequence.idl>
#include <com/sun/star/drawing/ColorMode.idl>
#include <com/sun/star/container/XIndexContainer.idl>
#include <com/sun/star/graphic/XGraphic.idl>

//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

/** specifies a graphic which can be embedded in <type>Text</type>.
 */
published service TextGraphicObject
{
    /** contains the definition of interfaces and properties that are supported by text frames,
     graphic objects and embedded objects.
     */
    service BaseFrame;
    //-------------------------------------------------------------------------
    /** returns the client-side image map if one is assigned to the object.
     */
    [property] com::sun::star::container::XIndexContainer ImageMap;

    //-------------------------------------------------------------------------

    /** determines if the content is protected against changes from the user interface.
     */
    [property] boolean ContentProtected;

    //-------------------------------------------------------------------------

    /** determines if the text wraps around the contour of the object.
     */
    [property] boolean SurroundContour;
    //-------------------------------------------------------------------------

    /** the text flows only around the contour of the object.
     */
    [property] boolean ContourOutside;
    //-------------------------------------------------------------------------
    /** contains the contour of the object as PolyPolygon.
     */
    [optional, property] com::sun::star::drawing::PointSequenceSequence ContourPolyPolygon;
    //-------------------------------------------------------------------------
    //-------------------------------------------------------------------------

    /** contains the cropping of the object.@see GraphicCrop
     */
    [property] com::sun::star::text::GraphicCrop GraphicCrop;

    //-------------------------------------------------------------------------
    /** determines if the object is horizontally mirrored on even pages.
     */
    [property] boolean HoriMirroredOnEvenPages;
     //-------------------------------------------------------------------------
    /** determines if the object is horizontally mirrored on odd pages.
     */
    [property] boolean HoriMirroredOnOddPages;
    //-------------------------------------------------------------------------
    //-------------------------------------------------------------------------
    /** determines if the object is mirrored vertically.
     */
    [property] boolean VertMirrored;

    /** contains the URL of the background graphic of the object
     */
    [property] string GraphicURL;

    //-------------------------------------------------------------------------

    /** contains the name of the filter of the background graphic of the object.
     */
    [property] string GraphicFilter;

    //-------------------------------------------------------------------------
    /** contains the original size of the bitmap in the graphic object.
     */
    [property] com::sun::star::awt::Size ActualSize;
    //-------------------------------------------------------------------------
    /** changes the display of the luminance.
         It contains percentage values between -100 and +100.
     */
    [property] short AdjustLuminance;
    //-------------------------------------------------------------------------
    /** changes the display of contrast.
         It contains percentage values between -100 and +100.
     */
    [property] short AdjustContrast;
    //-------------------------------------------------------------------------
    /** changes the display of the red color channel.
         It contains percentage values between -100 and +100.
     */
    [property] short AdjustRed;
    //-------------------------------------------------------------------------
    /** changes the display of the green color channel.
         It contains percentage values between -100 and +100.
     */
    [property] short AdjustGreen;
    //-------------------------------------------------------------------------
    /** changes the display of the blue color channel.
         It contains percentage values between -100 and +100.
     */
    [property] short AdjustBlue;
    //-------------------------------------------------------------------------
    /** determines the gamma value of the graphic.
     */
    [property] double Gamma;
    //-------------------------------------------------------------------------
    /** determines if the graphic is display in inverted colors.
         It contains percentage values between -100 and +100.
     */
    [property] boolean GraphicIsInverted;
    //-------------------------------------------------------------------------
    /** .
         It contains percentage values between -100 and +100.
     */
    [property] short Transparency;
    //-------------------------------------------------------------------------
    /** contains the ColorMode as <type scope="com::sun::star::drawing">ColorMode</type>.
     */
    [property] com::sun::star::drawing::ColorMode  GraphicColorMode;
    //-------------------------------------------------------------------------
    /** contains the graphic.
     */
    [optional, property] com::sun::star::graphic::XGraphic    Graphic;

};

//=============================================================================

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
