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

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