1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_text_textfield_PageNumber_idl__
29#define __com_sun_star_text_textfield_PageNumber_idl__
30
31#include <com/sun/star/text/TextField.idl>
32#include <com/sun/star/text/PageNumberType.idl>
33
34//=============================================================================
35
36module com { module sun { module star { module text { module textfield {
37
38//=============================================================================
39/** specifies service of a page number text field.
40	@see com::sun::star::text::TextField
41*/
42published service PageNumber
43{
44	service  com::sun::star::text::TextField;
45
46    /** determins the type of the numbering.
47     @see <const scope="com::sun::star::style">NumberingType</const>
48     */
49    [property] short NumberingType;
50
51    /** determins an offset value to show a different page number.
52     */
53    [property] short Offset;
54    /** determins which page the field refers to.
55        @see <const scope="com::sun::star::text">PageNumberType</const>
56     */
57    [property] PageNumberType SubType;
58    /** if the user text string is set then it is displayed when the value
59     of NumberingType is set to <const scope="com::sun::star::style">NumberingType::CHAR_SPECIAL</const>
60          */
61    [property] string UserText;
62
63};
64
65//=============================================================================
66
67}; }; }; }; };
68
69#endif
70
71