diff options
author | Rüdiger Timm <rt@openoffice.org> | 2007-07-06 06:21:56 +0000 |
---|---|---|
committer | Rüdiger Timm <rt@openoffice.org> | 2007-07-06 06:21:56 +0000 |
commit | d69ac9bf0a61e5cefa75a804a896ab25ebef0d79 (patch) | |
tree | ecedcaa42eb7f7312a0d55d49a83b2771f27dda6 /offapi | |
parent | 9a5d03f38c4507ee51792348f73a1950c9e59a4f (diff) |
INTEGRATION: CWS oj14 (1.1.2); FILE ADDED
2007/04/27 10:55:31 oj 1.1.2.1: #i76758# new report api
Diffstat (limited to 'offapi')
-rw-r--r-- | offapi/com/sun/star/report/XImageControl.idl | 92 | ||||
-rw-r--r-- | offapi/com/sun/star/report/XReportComponent.idl | 163 | ||||
-rw-r--r-- | offapi/com/sun/star/report/XReportControlFormat.idl | 458 |
3 files changed, 713 insertions, 0 deletions
diff --git a/offapi/com/sun/star/report/XImageControl.idl b/offapi/com/sun/star/report/XImageControl.idl new file mode 100644 index 000000000000..4cec991e7e6d --- /dev/null +++ b/offapi/com/sun/star/report/XImageControl.idl @@ -0,0 +1,92 @@ +/************************************************************************* + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XImageControl.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: rt $ $Date: 2007-07-06 07:21:30 $ + * + * The Contents of this file are made available subject to + * the terms of GNU Lesser General Public License Version 2.1. + * + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2005 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + ************************************************************************/ +#ifndef __com_sun_star_report_XImageControl_idl__ +#define __com_sun_star_report_XImageControl_idl__ + +#ifndef __com_sun_star_report_XReportControlModel_idl__ +#include <com/sun/star/report/XReportControlModel.idl> +#endif +#ifndef __com_sun_star_form_XImageProducerSupplier_idl__ +#include <com/sun/star/form/XImageProducerSupplier.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= +interface XImageControl +{ + interface XReportControlModel; + + /** supplies the caller with an <type scope="com::sun::star::awt">XImageProducer</type>. + + <p>Other components can register as <type scope="com::sun::star::awt">XImageConsumer</type> + at this producer. Then they will be notified of any change in the image to be displayed.</p> + + <p>Whenever the <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member> + property is changed, the model loads the specified image, and sets it as image source + at its <type scope="com::sun::star::awt">XImageProducer</type>. Then, all + <type scope="com::sun::star::awt">XImageConsumer</type>s are notified and supplied with + the binary data of the image.<br/> + Usually, controls acting for an <type>ImageControl</type> model are consumers, and use the + data stream to display the image</p> + */ + interface com::sun::star::form::XImageProducerSupplier; + + /** specifies an URL to an image to use for the control. + */ + [attribute,bound] string ImageURL; + + /** specifies if the image is automatically scaled to the size of the + control. + */ + [attribute,bound] boolean ScaleImage; + + /** Specifies that the IRI given in the data field should be preserved, otherwise the content will be inserted in the resulting report document. + If the data field contains something different as string then this attribute will be ignored. + */ + [attribute,bound] boolean PreserveIRI; +}; + +service ImageControl : XImageControl; +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/XReportComponent.idl b/offapi/com/sun/star/report/XReportComponent.idl new file mode 100644 index 000000000000..b1ca15f18abc --- /dev/null +++ b/offapi/com/sun/star/report/XReportComponent.idl @@ -0,0 +1,163 @@ +/************************************************************************* + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XReportComponent.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: rt $ $Date: 2007-07-06 07:21:40 $ + * + * The Contents of this file are made available subject to + * the terms of GNU Lesser General Public License Version 2.1. + * + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2005 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + ************************************************************************/ +#ifndef __com_sun_star_report_XReportComponent_idl__ +#define __com_sun_star_report_XReportComponent_idl__ + +#ifndef __com_sun_star_container_XChild_idl__ +#include <com/sun/star/container/XChild.idl> +#endif + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif +#ifndef __com_sun_star_util_XCloneable_idl__ +#include <com/sun/star/util/XCloneable.idl> +#endif +#ifndef __com_sun_star_awt_XControlModel_idl__ +#include <com/sun/star/awt/XControlModel.idl> +#endif +#ifndef __com_sun_star_drawing_XShape_idl__ +#include <com/sun/star/drawing/XShape.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module report { + interface XSection; +//============================================================================= +/** describes a component which may be part of a report. + + @see XReportDefinition + */ +interface XReportComponent +{ + interface com::sun::star::util::XCloneable; + /** identifies the component as a candidate for being part of a report. + <p>This interface also provides the access to the component's parent.</p> + */ + interface com::sun::star::container::XChild; + + /** allows life-time control of report components. + */ + interface com::sun::star::lang::XComponent; + + interface com::sun::star::drawing::XShape; + + /** gives access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + /** the name of the component. + */ + [attribute,bound] string Name + { + set raises ( com::sun::star::beans::PropertyVetoException ); + }; + + /** specifies the height of the control. + */ + [attribute,bound] long Height; + + /** specifies the horizontal position of the control. + */ + [attribute,bound] long PositionX; + + /** specifies the vertical position of the control. + */ + [attribute,bound] long PositionY; + + /** specifies the width of the control. + */ + [attribute,bound] long Width; + + /** specifies the border style of the control. + + <pre> + 0: No border + 2: simple border + </pre> + */ + [attribute,bound] short ControlBorder + { + set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** specifies the color of the border, if present + + <p>Not every border style (see <member>Border</member>) may support coloring. + For instance, usually a border with 3D effect will ignore the BorderColor setting.</p> + */ + [attribute,bound] long ControlBorderColor + { + set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** Specifies that recurring values are printed. + If set to <TRUE/> then the value will be printed every time. If set to <FALSE/> then the value will only be printed once. + The default value is <TRUE/>. + */ + [attribute,bound] boolean PrintRepeatedValues + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** Specifies the section where the control belongs to. + This is a shortcut to get control hierachy up. + This value is <NULL/> when the control was not inserted in any section. + */ + [attribute,readonly] com::sun::star::report::XSection Section; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/XReportControlFormat.idl b/offapi/com/sun/star/report/XReportControlFormat.idl new file mode 100644 index 000000000000..cda313597de3 --- /dev/null +++ b/offapi/com/sun/star/report/XReportControlFormat.idl @@ -0,0 +1,458 @@ +/************************************************************************* + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XReportControlFormat.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: rt $ $Date: 2007-07-06 07:21:56 $ + * + * The Contents of this file are made available subject to + * the terms of GNU Lesser General Public License Version 2.1. + * + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2005 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + ************************************************************************/ +#ifndef __com_sun_star_report_XReportControlFormat_idl__ +#define __com_sun_star_report_XReportControlFormat_idl__ + +#ifndef __com_sun_star_awt_FontDescriptor_idl__ +#include <com/sun/star/awt/FontDescriptor.idl> +#endif +#ifndef __com_sun_star_util_Color_idl__ +#include <com/sun/star/util/Color.idl> +#endif +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif +#include <com/sun/star/lang/Locale.idl> + +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= +/** specifies a format condition for a control. +*/ +interface XReportControlFormat +{ + /** specifies the background color (RGB) of the control. + */ + [attribute,bound] com::sun::star::util::Color ControlBackground + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** determines if the back ground color is set to transparent. + */ + [attribute,bound] boolean ControlBackgroundTransparent + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies the horizontal alignment of the text in the control. + + <pre> + 0: left + 1: center + 2: right + </pre> + + @since OOo 2.0.0 + */ + [attribute,bound] short ParaAdjust; + + //------------------------------------------------------------------------- + + /** specifies the font attributes of the text in the control. + */ + [attribute,bound] com::sun::star::awt::FontDescriptor FontDescriptor + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> + value of the text in the control. + */ + [attribute,bound] short ControlTextEmphasis + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** contains the font emphasis value as <type scope="com::sun::star::text">FontEmphasis</type>. + */ + [attribute,bound] short CharEmphasis + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** determins whether text is formatted in two lines. + <p>It is linked to the properties CharCombinePrefix and CharCombineSuffix.</p> + */ + [attribute,bound] boolean CharCombineIsOn + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** contains the prefix (usually parenthesis) before text that is formatted in two lines. + <p>It is linked to the properties CharCombineIsOn and CharCombineSuffix.</p> + */ + [attribute,bound] string CharCombinePrefix + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** contains the suffix (usually parenthesis) after text that is formatted in two lines. + <p>It is linked to the properties CharCombineIsOn and CharCombinePrefix.</p> + */ + [attribute,bound] string CharCombineSuffix + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** If this optional property is <TRUE/>, then the characters are invisible. + + @since OOo 2.0.0 + */ + [attribute,bound] boolean CharHidden + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + /** specifies if the characters are formatted and + displayed with a shadow effect. + */ + [attribute,bound] boolean CharShadowed + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies if the characters are formatted and + displayed with a contour effect. + */ + [attribute,bound] boolean CharContoured + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** optional property which contains the value of the case-mapping of the + text for formatting and displaying. + + @see CaseMap + */ + [attribute,bound] short CharCaseMap + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** contains the value of the locale. + */ + [attribute,bound] com::sun::star::lang::Locale CharLocale + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies the percentage of raisement/lowerment of superscript/subscript + characters. + + <p>Negative values denote subscripts and positive values superscripts.</p> + */ + [attribute,bound] short CharEscapement + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** This is the additional height used for subscript or superscript + characters in units of percent. + For subscript characters the value is negative and for + superscript characters positive. + */ + [attribute,bound] byte CharEscapementHeight + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** optional property to determine whether the kerning tables from the current font are used. + <p>Automatic <em>kerning</em> applies a spacing in between certain + pairs of characters to make the text look better.</p> + */ + [attribute,bound] boolean CharAutoKerning + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** optional property which contains the value of the kerning of the characters. + */ + [attribute,bound] short CharKerning + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** If this optional property is <TRUE/>, then the characters are flashing. + */ + [attribute,bound] boolean CharFlash + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies the <type scope="com::sun::star::text">FontRelief</type> + value of the text in the control. + */ + [attribute,bound] short CharRelief + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** This attribute specifies the name of the font style. + + + + <p>It may contain more than one name separated by comma.</p> + */ + [attribute,bound] string CharFontName + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + + /** This attribute contains the name of the font style. + + <p>This attribute may be empty.</p> + */ + [attribute,bound] string CharFontStyleName + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + + /** This attribute contains font family as specified in + com.sun.star.awt.FontFamily . + */ + [attribute,bound] short CharFontFamily + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + + /** This attribute contains the text encoding of the font as specified in + com.sun.star.awt.CharSet. + */ + [attribute,bound] short CharFontCharSet + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + + /** This attribute contains the font pitch as specified in com.sun.star.awt.FontPitch. + */ + [attribute,bound] short CharFontPitch + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies the text color (RGB) of the control. + */ + [attribute,bound] com::sun::star::util::Color CharColor + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** specifies the text line color (RGB) of the control. + */ + [attribute,bound] com::sun::star::util::Color CharUnderlineColor + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** This value contains the height of the characters in point. + */ + [attribute,bound] float CharHeight + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** This attribute contains the value for the character underline.@see com::sun::star::awt::FontUnderline + */ + [attribute,bound] short CharUnderline + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** This attribute contains the value of the font weight.@see com::sun::star::awt::FontWeight + */ + [attribute,bound] float CharWeight + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** This attribute contains the value of the posture of the document.@see com::sun::star::awt::FontSlant + */ + [attribute,bound] com::sun::star::awt::FontSlant CharPosture + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + /** determins the type of the strike out of the character. + @see com.sun.star.awt.FontStrikeout + */ + [attribute,bound] short CharStrikeout + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** If this attribute is <TRUE/>, the underline and strike-through + properties are not applied to white spaces. + */ + [attribute,bound] boolean CharWordMode + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** determins the rotation of a character in degree. + <p>Depending on the implementation only certain values may be allowed. + </p> + */ + [attribute,bound] short CharRotation + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + + /** determins the percentage value for scaling the width of characters. + + <p>The value refers to the original width which is denoted by 100, + and it has to be greater than 0.</p> + + */ + [attribute,bound] short CharScaleWidth + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies the vertical alignment of the text in the control. + @see com::sun::star::text::ParagraphVertAlign + */ + [attribute,bound] short ParaVertAlignment + { + set raises ( com::sun::star::lang::IllegalArgumentException ); + }; + + //------------------------------------------------------------------------- + /** contains the URL of a hyperlink (if set). + */ + [attribute,bound] string HyperLinkURL + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + /** contains the name of the target for a hyperlink (if set). + */ + [attribute,bound] string HyperLinkTarget + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + /** contains the name of the hyperlink (if set). + */ + [attribute,bound] string HyperLinkName + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //-------------------------------------------------------------------- + /** contains the character style name for visited hyperlinks. + */ + [attribute,bound] string VisitedCharStyleName + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //-------------------------------------------------------------------- + /** contains the character style name for unvisited hyperlinks. + */ + [attribute,bound] string UnvisitedCharStyleName + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; +}; + +service ReportControlFormat : XReportControlFormat; +//============================================================================= + +}; }; }; }; +#endif |