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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_text_textfield_PageNumber_idl__
  21 #define __com_sun_star_text_textfield_PageNumber_idl__
  22
  23 #include <com/sun/star/text/TextField.idl>
  24 #include <com/sun/star/text/PageNumberType.idl>
  25
  26
  27 module com { module sun { module star { module text { module textfield {
  28
  29 /** specifies service of a page number text field.
  30     @see com::sun::star::text::TextField
  31 */
  32 published service PageNumber
  33 {
  34     service  com::sun::star::text::TextField;
  35
  36     /** determines the type of the numbering.
  37      @see com::sun::star::style::NumberingType
  38      */
  39     [property] short NumberingType;
  40
  41     /** determines an offset value to show a different page number.
  42      */
  43     [property] short Offset;
  44     /** determines which page the field refers to.
  45         @see com::sun::star::text::PageNumberType
  46      */
  47     [property] PageNumberType SubType;
  48     /** if the user text string is set then it is displayed when the value
  49      of NumberingType is set to com::sun::star::style::NumberingType::CHAR_SPECIAL
  50           */
  51     [property] string UserText;
  52
  53 };
  54
  55
  56 }; }; }; }; };
  57
  58 #endif
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */