blob: d4e72e93fe31de20237f543cc09d9b8f261d2b18 [file] [log] [blame]
/**************************************************************
*
* 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_sheet_TableAutoFormatField_idl__
#define __com_sun_star_sheet_TableAutoFormatField_idl__
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif
#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif
#ifndef __com_sun_star_awt_FontSlant_idl__
#include <com/sun/star/awt/FontSlant.idl>
#endif
#ifndef __com_sun_star_table_ShadowFormat_idl__
#include <com/sun/star/table/ShadowFormat.idl>
#endif
#ifndef __com_sun_star_table_CellHoriJustify_idl__
#include <com/sun/star/table/CellHoriJustify.idl>
#endif
#ifndef __com_sun_star_table_CellVertJustify_idl__
#include <com/sun/star/table/CellVertJustify.idl>
#endif
#ifndef __com_sun_star_table_CellOrientation_idl__
#include <com/sun/star/table/CellOrientation.idl>
#endif
#ifndef __com_sun_star_table_TableBorder_idl__
#include <com/sun/star/table/TableBorder.idl>
#endif
//=============================================================================
module com { module sun { module star { module sheet {
//=============================================================================
/** represents a field in an AutoFormat. A field contains all cell
properties for a specific position in an AutoFormat.
*/
published service TableAutoFormatField
{
//-------------------------------------------------------------------------
//! service com::sun::star::beans::PropertySet;
/** provides access to the properties.
*/
interface com::sun::star::beans::XPropertySet;
//-------------------------------------------------------------------------
/** specifies the name of the western font.
*/
[property] string CharFontName;
/** specifies the name of the asian font.
*/
[optional, property] string CharFontNameAsian;
/** specifies the name of the complex font.
*/
[optional, property] string CharFontNameComplex;
//-------------------------------------------------------------------------
/** specifies the name of the western font style.
*/
[property] string CharFontStyleName;
/** specifies the name of the asian font style.
*/
[optional, property] string CharFontStyleNameAsian;
/** specifies the name of the complex font style.
*/
[optional, property] string CharFontStyleNameComplex;
//-------------------------------------------------------------------------
/** contains the value of the character set of the western font.
*/
[property] string CharFontCharSet;
/** contains the value of the character set of the asian font.
*/
[optional, property] string CharFontCharSetAsian;
/** contains the value of the character set of the complex font.
*/
[optional, property] string CharFontCharSetComplex;
//-------------------------------------------------------------------------
/** contains the value of the western font family.
*/
[property] string CharFontFamily;
/** contains the value of the asian font family.
*/
[optional, property] string CharFontFamilyAsian;
/** contains the value of the complex font family.
*/
[optional, property] string CharFontFamilyComplex;
//-------------------------------------------------------------------------
/** contains the value of the pitch of the western font.
*/
[property] string CharFontPitch;
/** contains the value of the pitch of the asian font.
*/
[optional, property] string CharFontPitchAsian;
/** contains the value of the pitch of the complex font.
*/
[optional, property] string CharFontPitchComplex;
//-------------------------------------------------------------------------
/** contains the height of characters of the western font in point.
*/
[property] float CharHeight;
/** contains the height of characters of the asian font in point.
*/
[optional, property] float CharHeightAsian;
/** contains the height of characters of the complex font in point.
*/
[optional, property] float CharHeightComplex;
//-------------------------------------------------------------------------
/** contains the value for the weight of characters of the western font.
*/
[property] float CharWeight;
/** contains the value for the weight of characters of the asian font.
*/
[optional, property] float CharWeightAsian;
/** contains the value for the weight of characters of the complex font.
*/
[optional, property] float CharWeightComplex;
//-------------------------------------------------------------------------
/** contains the value of the posture of characters of the western font.
*/
[property] com::sun::star::awt::FontSlant CharPosture;
/** contains the value of the posture of characters of the asian font.
*/
[optional, property] com::sun::star::awt::FontSlant CharPostureAsian;
/** contains the value of the posture of characters of the comlex font.
*/
[optional, property] com::sun::star::awt::FontSlant CharPostureComplex;
//-------------------------------------------------------------------------
/** contains the value for the character underline.
*/
[property] short CharUnderline;
//-------------------------------------------------------------------------
/** is <TRUE/> if the characters are crossed out.
*/
[property] boolean CharCrossedOut;
//-------------------------------------------------------------------------
/** is <TRUE/> if the characters are contoured.
*/
[property] boolean CharContoured;
//-------------------------------------------------------------------------
/** is <TRUE/> if the characters are shadowed.
*/
[property] boolean CharShadowed;
//-------------------------------------------------------------------------
/** contains the value of the text color.
*/
[property] com::sun::star::util::Color CharColor;
//-------------------------------------------------------------------------
/** contains the cell background color.
*/
[property] com::sun::star::util::Color CellBackColor;
//-------------------------------------------------------------------------
/** is <TRUE/> if the cell background is transparent.
<p>In this case the <member>TableAutoFormatField::CellBackColor</member>
value is not used.</p>
*/
[property] boolean IsCellBackgroundTransparent;
//-------------------------------------------------------------------------
/** contains a description of the shadow.
*/
[optional, property] com::sun::star::table::ShadowFormat ShadowFormat;
//-------------------------------------------------------------------------
/** specifies the horizontal alignment of the cell contents.
*/
[optional, property] com::sun::star::table::CellHoriJustify HoriJustify;
//-------------------------------------------------------------------------
/** specifies the vertical alignment of the cell contents.
*/
[optional, property] com::sun::star::table::CellVertJustify VertJustify;
//-------------------------------------------------------------------------
/** is <TRUE/> if text breaks automatically at cell borders.
*/
[optional, property] boolean IsTextWrapped;
//-------------------------------------------------------------------------
/** contains the orientation of the cell contents
(i.e. top-to-bottom or stacked).
*/
[optional, property] com::sun::star::table::CellOrientation Orientation;
//-------------------------------------------------------------------------
/** contains the rotation angle of the cell contents.
*/
[optional, property] long RotateAngle;
//-------------------------------------------------------------------------
/** contains the reference egde of the cell rotation.
*/
[optional, property] com::sun::star::table::CellVertJustify RotateReference;
//-------------------------------------------------------------------------
/** contains the margin between cell contents and top border
(in 1/100 mm).
*/
[optional, property] long ParaTopMargin;
//-------------------------------------------------------------------------
/** contains the margin between cell contents and bottom border
(in 1/100 mm).
*/
[optional, property] long ParaBottomMargin;
//-------------------------------------------------------------------------
/** contains the margin between cell contents and left border
(in 1/100 mm).
*/
[optional, property] long ParaLeftMargin;
//-------------------------------------------------------------------------
/** contains the margin between cell contents and right border
(in 1/100 mm).
*/
[optional, property] long ParaRightMargin;
//-------------------------------------------------------------------------
/** property containing a description of the cell border.
@since OpenOffice 1.1.2
*/
[optional, property] com::sun::star::table::TableBorder TableBorder;
};
//=============================================================================
}; }; }; };
//=============================================================================
#endif