offapi/com/sun/star/text/textfield/docinfo/CreateDateTime.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
  21 module com { module sun { module star {
  22     module text { module textfield { module docinfo {
  23
  24 /** specifies service of a text field that provides information about the date
  25  and time of the document creation.
  26     @see com::sun::star::text::TextField
  27 */
  28 published service CreateDateTime
  29 {
  30     service  com::sun::star::text::TextField;
  31     /** contains the current content of the text field.
  32         <p> This property is especially useful for import/export purposes. </p>
  33      */
  34     [property]string CurrentPresentation;
  35     /** If this flag is set to false the author
  36         will be overridden by the current author
  37         each time the document is saved.
  38      */
  39     /** If this flag is set to `FALSE` the date or time
  40         is always displayed as the current date or time.
  41
  42     @since OOo 1.1.2
  43      */
  44     [optional, property] boolean IsFixed;
  45     /** If this flag is set to `TRUE` this field represents,
  46         a date with an optional time. If it is set to `FALSE`
  47         only the time is used here.
  48      */
  49     [property]boolean IsDate;
  50     /** contains the date and time as double value.
  51      */
  52     [property]double DateTimeValue;
  53     /** this is the number format for this field.
  54         @see com::sun::star::util::NumberFormatter
  55     */
  56     [property]long NumberFormat;
  57     /** determines whether changes in language attributes at the position the text field
  58         is located also change the number format as appropriate for this language.
  59      */
  60     [optional, property] boolean IsFixedLanguage;
  61 };
  62
  63
  64 }; }; }; }; }; };
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */