1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_text_textfield_PageNumber_idl__
25#define __com_sun_star_text_textfield_PageNumber_idl__
26
27#include <com/sun/star/text/TextField.idl>
28#include <com/sun/star/text/PageNumberType.idl>
29
30//=============================================================================
31
32module com { module sun { module star { module text { module textfield {
33
34//=============================================================================
35/** specifies service of a page number text field.
36	@see com::sun::star::text::TextField
37*/
38published service PageNumber
39{
40	service  com::sun::star::text::TextField;
41
42    /** determines the type of the numbering.
43     @see <const scope="com::sun::star::style">NumberingType</const>
44     */
45    [property] short NumberingType;
46
47    /** determines an offset value to show a different page number.
48     */
49    [property] short Offset;
50    /** determines which page the field refers to.
51        @see <const scope="com::sun::star::text">PageNumberType</const>
52     */
53    [property] PageNumberType SubType;
54    /** if the user text string is set then it is displayed when the value
55     of NumberingType is set to <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>
56          */
57    [property] string UserText;
58
59};
60
61//=============================================================================
62
63}; }; }; }; };
64
65#endif
66
67