summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/TextPageStyle.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/text/TextPageStyle.idl')
-rw-r--r--offapi/com/sun/star/text/TextPageStyle.idl230
1 files changed, 230 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/TextPageStyle.idl b/offapi/com/sun/star/text/TextPageStyle.idl
new file mode 100644
index 000000000000..9ae88bfe6010
--- /dev/null
+++ b/offapi/com/sun/star/text/TextPageStyle.idl
@@ -0,0 +1,230 @@
+/*************************************************************************
+ *
+ * $RCSfile: TextPageStyle.idl,v $
+ *
+ * $Revision: 1.2 $
+ *
+ * last change: $Author: mi $ $Date: 2002-10-03 13:10:05 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 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
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_text_TextPageStyle_idl__
+#define __com_sun_star_text_TextPageStyle_idl__
+
+#ifndef __com_sun_star_table_ShadowFormat_idl__
+#include <com/sun/star/table/ShadowFormat.idl>
+#endif
+#ifndef __com_sun_star_table_BorderLine_idl__
+#include <com/sun/star/table/BorderLine.idl>
+#endif
+#ifndef __com_sun_star_style_PageStyleLayout_idl__
+#include <com/sun/star/style/PageStyleLayout.idl>
+#endif
+#ifndef __com_sun_star_style_GraphicLocation_idl__
+#include <com/sun/star/style/GraphicLocation.idl>
+#endif
+#ifndef __com_sun_star_awt_Size_idl__
+#include <com/sun/star/awt/Size.idl>
+#endif
+#ifndef __com_sun_star_text_XText_idl__
+#include <com/sun/star/text/XText.idl>
+#endif
+#ifndef __com_sun_star_text_XTextColumns_idl__
+#include <com/sun/star/text/XTextColumns.idl>
+#endif
+#ifndef __com_sun_star_container_XNameContainer_idl__
+#include <com/sun/star/container/XNameContainer.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module text {
+
+//=============================================================================
+
+/** represents a page style for a text document.
+
+ <p>This service extends the service
+ <type scope="com::sun::star::style">PageStyle</type> with specific
+ properties for text documents.</p>
+ */
+service TextPageStyle
+{
+ //-------------------------------------------------------------------------
+
+ /** determins whether the register mode is active on that page.
+ */
+ [property] boolean RegisterModeActive;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the name of the paragraph style that is used as
+ reference of the register mode.
+ */
+ [property] string RegisterParagraphStyle;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the column settings of the page.
+ */
+ [property] com::sun::star::text::XTextColumns TextColumns;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the interface to the text of the header.
+
+ @see com::sun::star::text::Text
+ */
+ [property] com::sun::star::text::XText HeaderText;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the interface to the text of the header of left pages.
+
+ @see com::sun::star::text::Text
+ */
+ [property] com::sun::star::text::XText HeaderTextLeft;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the interface to the text of the header of right pages.
+
+ @see com::sun::star::text::Text
+ */
+ [property] com::sun::star::text::XText HeaderTextRight;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the interface to the text of the footer.
+
+ @see com::sun::star::text::Text
+ */
+ [property] com::sun::star::text::XText FooterText;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the interface to the text of the footer of a left page.
+
+ @see com::sun::star::text::Text
+ */
+ [property] com::sun::star::text::XText FooterTextLeft;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the interface to the text of the footer of a right page.
+
+ @see com::sun::star::text::Text
+ */
+ [property] com::sun::star::text::XText FooterTextRight;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the maximum height of the footnote area (in 1/100 mm).
+
+ <p>If set to zero, the height of the current page is used as limit.</p>
+ */
+ [property] long FootnoteHeight;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the weight of the separator line between the text and
+ the footnote area (in 1/100 mm).
+ */
+ [property] short FootnoteLineWeight;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the color of the separator line between the text and
+ the footnote area.
+ */
+ [property] long FootnoteLineColor;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the relative width of the separator line between the
+ text and the footnote area (in percent).
+ */
+ [property] byte FootnoteLineRelativeWidth;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the adjustment of the separator line between the text
+ and the footnote area.
+
+ @see com::sun::star::text::HorizontalAdjust
+ */
+ [property] short FootnoteLineAdjust;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the distance between the text and the separator line
+ between the text and the footnote area (in 1/100 mm).
+ */
+ [property] long FootnoteLineTextDistance;
+
+ //-------------------------------------------------------------------------
+
+ /** contains the distance between the footnote area and the separator
+ line between the text and the footnote area (in 1/100 mm).
+ */
+ [property] long FootnoteLineDistance;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+
generated by cgit (git 2.34.1) at 2024-08-11 13:41:53 +0000