/************************************************************************* * * 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 * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef __com_sun_star_style_PageProperties_idl__ #define __com_sun_star_style_PageProperties_idl__ #ifndef __com_sun_star_table_ShadowFormat_idl__ #include #endif #ifndef __com_sun_star_util_Color_idl__ #include #endif #ifndef __com_sun_star_table_BorderLine_idl__ #include #endif #ifndef __com_sun_star_style_PageStyleLayout_idl__ #include #endif #ifndef __com_sun_star_style_GraphicLocation_idl__ #include #endif #ifndef __com_sun_star_awt_Size_idl__ #include #endif #ifndef __com_sun_star_text_XText_idl__ #include #endif #ifndef __com_sun_star_text_XTextColumns_idl__ #include #endif #ifndef __com_sun_star_container_XNameContainer_idl__ #include #endif #ifndef __com_sun_star_text_WritingMode2_idl__ #include #endif //============================================================================= module com { module sun { module star { module style { //============================================================================= /** describes the style of pages. */ published service PageProperties { //----------------------------------------------------------------------------- /** contains the background color of the page. */ [property] com::sun::star::util::Color BackColor; //----------------------------------------------------------------------------- /** */ //[property] BackGraphic; //----------------------------------------------------------------------------- /** contains the URL of the background graphic. */ [property] string BackGraphicURL; //----------------------------------------------------------------------------- /** contains the filter name of the background graphic. */ [property] string BackGraphicFilter; //----------------------------------------------------------------------------- /** determins the location of the background graphic. */ [property] com::sun::star::style::GraphicLocation BackGraphicLocation; //----------------------------------------------------------------------------- /** determins if the background color is transparent.

If this property is set to , PageStyle::BackColor will not be used.

*/ [property] boolean BackTransparent; //----------------------------------------------------------------------------- /** determins the left margin of the page. */ [property] long LeftMargin; //----------------------------------------------------------------------------- /** determins the right margin of the page. */ [property] long RightMargin; //----------------------------------------------------------------------------- /** determins the top margin of the page. */ [property] long TopMargin; //----------------------------------------------------------------------------- /** determins the bottom margin of the page. */ [property] long BottomMargin; //----------------------------------------------------------------------------- /** determines the style of the left border line of the page. */ [property] com::sun::star::table::BorderLine LeftBorder; //----------------------------------------------------------------------------- /** determines the style of the right border line of the page. */ [property] com::sun::star::table::BorderLine RightBorder; //----------------------------------------------------------------------------- /** determines the style of the top border line of the page. */ [property] com::sun::star::table::BorderLine TopBorder; //----------------------------------------------------------------------------- /** determines the style of the bottom border line of the page. */ [property] com::sun::star::table::BorderLine BottomBorder; //----------------------------------------------------------------------------- /** determins the left border distance of the page. */ [property] long LeftBorderDistance; //----------------------------------------------------------------------------- /** determins the right border distance of the page. */ [property] long RightBorderDistance; //----------------------------------------------------------------------------- /** determins the top border distance of the page. */ [property] long TopBorderDistance; //----------------------------------------------------------------------------- /** determins the bottom border distance of the page. */ [property] long BottomBorderDistance; //----------------------------------------------------------------------------- /** determins the shadow of the page. */ [property] com::sun::star::table::ShadowFormat ShadowFormat; //----------------------------------------------------------------------------- /** determins if the page format is landscape. */ [property] boolean IsLandscape; //----------------------------------------------------------------------------- /** determins the default numbering type for this page. */ [property] short NumberingType; //----------------------------------------------------------------------------- /** determins the layout of the page. */ [property] com::sun::star::style::PageStyleLayout PageStyleLayout; //----------------------------------------------------------------------------- /** contains the name of a paper tray of the selected printer. */ [property] string PrinterPaperTray; //----------------------------------------------------------------------------- /** determins if the register mode is active on that page. */ [optional, property] boolean RegisterModeActive; //----------------------------------------------------------------------------- /** contains the name of the paragraph style that is used as reference of the register mode. */ [optional, property] string RegisterParagraphStyle; //----------------------------------------------------------------------------- /** contains the paper size of the page. */ [property] com::sun::star::awt::Size Size; //----------------------------------------------------------------------------- /** contains the width of the page. */ [property] long Width; //----------------------------------------------------------------------------- /** contains the height of the page. */ [property] long Height; //----------------------------------------------------------------------------- /** contains the column settings of the page. */ [optional , property] com::sun::star::text::XTextColumns TextColumns; //----------------------------------------------------------------------------- /** contains user defined attributes.

This XNameContainer supports the service AttributeContainer.

*/ [property] com::sun::star::container::XNameContainer UserDefinedAttributes; //----------------------------------------------------------------------------- /** contains the color of the background of the header. */ [property, maybevoid] com::sun::star::util::Color HeaderBackColor; //----------------------------------------------------------------------------- /** */ //[property, maybevoid] HeaderBackGraphic; //----------------------------------------------------------------------------- /** contains the URL of the background graphic of the header. */ [property, maybevoid] string HeaderBackGraphicURL; //----------------------------------------------------------------------------- /** contains the filter name of the background graphic of the header. */ [property, maybevoid] string HeaderBackGraphicFilter; //----------------------------------------------------------------------------- /** determines the location of the background graphic of the header. */ [property, maybevoid] com::sun::star::style::GraphicLocation HeaderBackGraphicLocation; //----------------------------------------------------------------------------- /** contains the left margin of the header. */ [property, maybevoid] long HeaderLeftMargin; //----------------------------------------------------------------------------- /** contains the right margin of the header. */ [property, maybevoid] long HeaderRightMargin; //----------------------------------------------------------------------------- /** determines if the background color of the header is transparent.

If this property is set to , PageStyle::HeaderBackColor will not be used.

*/ [property, maybevoid] boolean HeaderBackTransparent; //----------------------------------------------------------------------------- /** determines the style of the left border line of the header. */ [property, maybevoid] com::sun::star::table::BorderLine HeaderLeftBorder; //----------------------------------------------------------------------------- /** determines the style of the right border line of the header. */ [property, maybevoid] com::sun::star::table::BorderLine HeaderRightBorder; //----------------------------------------------------------------------------- /** determines the style of the top border line of the header. */ [property, maybevoid] com::sun::star::table::BorderLine HeaderTopBorder; //----------------------------------------------------------------------------- /** determines the style of the bottom border line of the header. */ [property, maybevoid] com::sun::star::table::BorderLine HeaderBottomBorder; //----------------------------------------------------------------------------- /** determines the left border distance of the header. */ [property, maybevoid] long HeaderLeftBorderDistance; //----------------------------------------------------------------------------- /** determines the right border distance of the header. */ [property, maybevoid] long HeaderRightBorderDistance; //----------------------------------------------------------------------------- /** determines the top border distance of the header. */ [property, maybevoid] long HeaderTopBorderDistance; //----------------------------------------------------------------------------- /** determines the bottom border distance of the header. */ [property, maybevoid] long HeaderBottomBorderDistance; //----------------------------------------------------------------------------- /** determines the shadow of the header. */ [property, maybevoid] com::sun::star::table::ShadowFormat HeaderShadowFormat; //----------------------------------------------------------------------------- /** determines the distance between the header and the body text area. */ [property, maybevoid] long HeaderBodyDistance; //----------------------------------------------------------------------------- /** determines if the header content on left and right pages is the same. */ [property, maybevoid] boolean HeaderIsShared; //----------------------------------------------------------------------------- /** contains the height of the header. */ [property, maybevoid] long HeaderHeight; //----------------------------------------------------------------------------- /** determines if the height of the header depends on the content. */ [property, maybevoid] boolean HeaderIsDynamicHeight; //----------------------------------------------------------------------------- /** determines if a header is used on the page. */ [property] boolean HeaderIsOn; //----------------------------------------------------------------------------- /** contains the interface to the text of the header. */ [optional, property, maybevoid] com::sun::star::text::XText HeaderText; //----------------------------------------------------------------------------- /** contains the interface to the text of the header of left pages. */ [optional, property, maybevoid] com::sun::star::text::XText HeaderTextLeft; //----------------------------------------------------------------------------- /** contains the interface to the text of the header of right pages. */ [optional, property, maybevoid] com::sun::star::text::XText HeaderTextRight; //----------------------------------------------------------------------------- /** contains the color of the background of the footer. */ [property, maybevoid] com::sun::star::util::Color FooterBackColor; //----------------------------------------------------------------------------- /** */ //[property, maybevoid] FooterBackGraphic; //----------------------------------------------------------------------------- /** contains the URL of the background graphic in the footer. */ [property, maybevoid] string FooterBackGraphicURL; //----------------------------------------------------------------------------- /** contains the filter name of the background graphic in the footer. */ [property, maybevoid] string FooterBackGraphicFilter; //----------------------------------------------------------------------------- /** determines the location of the background graphic in the footer. */ [property, maybevoid] com::sun::star::style::GraphicLocation FooterBackGraphicLocation; //----------------------------------------------------------------------------- /** determines the left margin of the footer. */ [property, maybevoid] long FooterLeftMargin; //----------------------------------------------------------------------------- /** determines the right margin of the footer. */ [property, maybevoid] long FooterRightMargin; //----------------------------------------------------------------------------- /** determines if the background of the footer is transparent. */ [property, maybevoid] boolean FooterBackTransparent; //----------------------------------------------------------------------------- /** contains the style of the left border line of the footer. */ [property, maybevoid] com::sun::star::table::BorderLine FooterLeftBorder; //----------------------------------------------------------------------------- /** contains the style of the right border line of the footer. */ [property, maybevoid] com::sun::star::table::BorderLine FooterRightBorder; //----------------------------------------------------------------------------- /** contains the style of the top border line of the footer. */ [property, maybevoid] com::sun::star::table::BorderLine FooterTopBorder; //----------------------------------------------------------------------------- /** contains the style of the bottom border line of the footer. */ [property, maybevoid] com::sun::star::table::BorderLine FooterBottomBorder; //----------------------------------------------------------------------------- /** contains the left border distance of the footer. */ [property, maybevoid] long FooterLeftBorderDistance; //----------------------------------------------------------------------------- /** contains the right border distance of the footer. */ [property, maybevoid] long FooterRightBorderDistance; //----------------------------------------------------------------------------- /** contains the top border distance of the footer. */ [property, maybevoid] long FooterTopBorderDistance; //----------------------------------------------------------------------------- /** contains the bottom border distance of the footer. */ [property, maybevoid] long FooterBottomBorderDistance; //----------------------------------------------------------------------------- /** determines the shadow of the footer. */ [property, maybevoid] com::sun::star::table::ShadowFormat FooterShadowFormat; //----------------------------------------------------------------------------- /** determines the distance between the footer and the body text area. */ [property, maybevoid] long FooterBodyDistance; //----------------------------------------------------------------------------- /** determines if the height of the footer depends on the content. */ [property, maybevoid] boolean FooterIsDynamicHeight; //----------------------------------------------------------------------------- /** determines if the footer content on left and right pages is the same. */ [property, maybevoid] boolean FooterIsShared; //----------------------------------------------------------------------------- /** determines the height of the footer. */ [property, maybevoid] long FooterHeight; //----------------------------------------------------------------------------- /** determines if a footer is used on the page. */ [property] boolean FooterIsOn; //----------------------------------------------------------------------------- /** contains the interface to the text of the footer. */ [optional, property, maybevoid] com::sun::star::text::XText FooterText; //----------------------------------------------------------------------------- /** contains the interface to the text of the footer of a left page. */ [optional, property, maybevoid] com::sun::star::text::XText FooterTextLeft; //----------------------------------------------------------------------------- /** contains the interface to the text of the footer of a right page. */ //----------------------------------------------------------------------------- /** contains . */ [optional, property, maybevoid] com::sun::star::text::XText FooterTextRight; //----------------------------------------------------------------------------- /** contains the maximum height of the footnote area. If set to zero then the height of the current page is used as limit. */ [optional,property] long FootnoteHeight; //----------------------------------------------------------------------------- /** contains the weight of the separator line between the text and the footnote area. */ [optional,property] short FootnoteLineWeight; //----------------------------------------------------------------------------- /** contains the color of the separator line between the text and the footnote area.. */ [optional,property] com::sun::star::util::Color FootnoteLineColor; //----------------------------------------------------------------------------- /** contains the relative width of the separator line between the text and the footnote area. */ [optional,property] byte FootnoteLineRelativeWidth; //----------------------------------------------------------------------------- /** contains the adjustment of the separator line between the text and the footnote area.

HorizontalAdjusts.

*/ [optional,property] short FootnoteLineAdjust; //----------------------------------------------------------------------------- /** contains the distance between the text and the separator line between the text and the footnote area. */ [optional,property] long FootnoteLineTextDistance; //----------------------------------------------------------------------------- /** contains the distance between the footnote area and the separator line between the text and the footnote area. */ [optional,property] long FootnoteLineDistance; //----------------------------------------------------------------------------- /** contains the writing direction, as represented by the WritingMode2 constants */ [optional,property] short WritingMode; //----------------------------------------------------------------------------- /** contains the mode of the text grid (none, lines, ...), as represented by TextGridMode constants */ [optional, property] short GridMode; //----------------------------------------------------------------------------- /** contains the display color of the text grid */ [optional, property] com::sun::star::util::Color GridColor; //----------------------------------------------------------------------------- /** contains the number of lines in the text grid */ [optional, property] short GridLines; //----------------------------------------------------------------------------- /** contains the height of the base text line inside the text grid */ [optional, property] long GridBaseHeight; //----------------------------------------------------------------------------- /** contains the height of the ruby text line inside the text grid */ [optional, property] long GridRubyHeight; //----------------------------------------------------------------------------- /** determines whether the text grid's ruby line is located below or above the base line */ [optional, property] boolean GridRubyBelow; //----------------------------------------------------------------------------- /** determines whether the text grid lines are printed */ [optional, property] boolean GridPrint; //----------------------------------------------------------------------------- /** determines whether the text grid lines are visible or not */ [optional, property] boolean GridDisplay; //----------------------------------------------------------------------------- /** determines whether to use dynamic spacing in header or not. */ [optional, property, maybevoid] boolean HeaderDynamicSpacing; //----------------------------------------------------------------------------- /** determines whether to use dynamic spacing in footer or not. */ [optional, property, maybevoid] boolean FooterDynamicSpacing; //----------------------------------------------------------------------------- /** determines the distance of all borders of the page. */ [property] long BorderDistance; //----------------------------------------------------------------------------- /** contains the distance of all borders of the footer. */ [property, maybevoid] long FooterBorderDistance; //----------------------------------------------------------------------------- /** determines the distance of all borders of the header. */ [property, maybevoid] long HeaderBorderDistance; }; //============================================================================= }; }; }; }; #endif