AOO410/main/offapi/com/sun/star/text/textfield/PageNumber.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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