/*************************************************************************
 *
 * 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
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#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
*/
published 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

