service of text field PageNumber

1 files changed, 104 insertions, 0 deletions

diff --git a/offapi/com/sun/star/text/textfield/PageNumber.idl b/offapi/com/sun/star/text/textfield/PageNumber.idl
new file mode 100644
index 000000000..36350bcf1
--- /dev/null
+++ b/offapi/com/sun/star/text/textfield/PageNumber.idl
@@ -0,0 +1,104 @@
+/*************************************************************************
+ *
+ *  $RCSfile: PageNumber.idl,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: os $ $Date: 2001-12-21 10:52: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_textfield_PageNumber_idl__
+#define __com_sun_star_text_textfield_PageNumber_idl__
+
+#include <com/sun/star/text/TextField.idl>
+#include <com/sun/star/text/PageNumberType.idl>
+
+//=============================================================================
+
+module com { module sun { module star { module text { module textfield {
+
+//=============================================================================
+/** specifies service of a page number text field.
+    @see com::sun::star::text::TextField
+*/
+service PageNumber
+{
+    service  com::sun::star::text::TextField;
+
+    /** determins the type of the numbering.
+     @see <const scope="com::sun::star::style">NumberingType</const>
+     */
+    [property] short NumberingType;
+
+    /** determins an offset value to show a different page number.
+     */
+    [property] short Offset;
+    /** determins which page the field refers to.
+        @see <const scope="com::sun::star::text">PageNumberType</const>
+     */
+    [property] PageNumberType SubType;
+    /** if the user text string is set then it is displayed when the value
+     of NumberingType is set to <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>
+          */
+    [property] string UserText;
+
+};
+
+//=============================================================================
+
+}; }; }; }; };
+
+#endif
+