xref: /trunk/main/offapi/com/sun/star/text/GraphicCrop.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_GraphicCrop_idl__
24#define __com_sun_star_text_GraphicCrop_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module text {
30
31//=============================================================================
32
33// DocMerge from xml: struct com::sun::star::text::GraphicCrop
34/** describes the cropping of graphic objects.
35	Cropping means to show only parts of the object.
36
37
38
39	<p>Negative values cut the visible area; positive values
40	extend the visible area by filling it with background color.
41	The absolute sum of top and bottom crop must be smaller
42	than the objects original height.  The absolute sum of the left and
43	right crop must be smaller than the object's original width.
44
45	</p>
46	<p>If this property is applied to a graphic object, then this object
47	will correct these values if necessary.
48	</p>
49 */
50published struct GraphicCrop
51{
52	// DocMerge from xml: field com::sun::star::text::GraphicCrop::Top
53	/** contains the top value to cut (if negative) or to extend (if positive)
54	 */
55	long Top;
56
57	//-------------------------------------------------------------------------
58
59	// DocMerge from xml: field com::sun::star::text::GraphicCrop::Bottom
60	/** contains the bottom value to cut (if negative) or to extend (if positive)
61	 */
62	long Bottom;
63
64	//-------------------------------------------------------------------------
65
66	// DocMerge from xml: field com::sun::star::text::GraphicCrop::Left
67	/** contains the left value to cut (if negative) or to extend (if positive)
68	 */
69	long Left;
70
71	//-------------------------------------------------------------------------
72
73	// DocMerge from xml: field com::sun::star::text::GraphicCrop::Right
74	/** contains the right value to cut (if negative) or to extend (if positive)
75	 */
76	long Right;
77
78};
79
80//=============================================================================
81
82}; }; }; };
83
84#endif
85