xref: /trunk/main/offapi/com/sun/star/text/TextGraphicObject.idl (revision d8faddcc)

/**************************************************************
 *
 * 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_text_TextGraphicObject_idl__
#define __com_sun_star_text_TextGraphicObject_idl__

#ifndef __com_sun_star_text_BaseFrame_idl__
#include <com/sun/star/text/BaseFrame.idl>
#endif

#ifndef __com_sun_star_text_GraphicCrop_idl__
#include <com/sun/star/text/GraphicCrop.idl>
#endif

#ifndef __com_sun_star_drawing_PointSequenceSequence_idl__
#include <com/sun/star/drawing/PointSequenceSequence.idl>
#endif
#ifndef __com_sun_star_drawing_ColorMode_idl__
#include <com/sun/star/drawing/ColorMode.idl>
#endif
#ifndef __com_sun_star_container_XIndexContainer_idl__
#include <com/sun/star/container/XIndexContainer.idl>
#endif
#ifndef __com_sun_star_graphic_XGraphic_idl__
#include <com/sun/star/graphic/XGraphic.idl>
#endif

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

 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 embeddedobjects.
	 */
	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