offapi/com/sun/star/text/textfield/DateTime.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 { module text { module textfield {
  22
  23 /** specifies service of a date or time text field.
  24     @see com::sun::star::text::TextField
  25 */
  26 published service DateTime
  27 {
  28     service  com::sun::star::text::TextField;
  29
  30     /** If this flag is set to `FALSE` the date or time
  31         is always displayed as the current date or time.
  32
  33         @since OOo 1.1.2
  34      */
  35     [optional, property] boolean IsFixed;
  36
  37     /** If this flag is set to `TRUE` this field represents
  38         a date with an optional time. If it is set to `FALSE`
  39         only the time is used here.
  40      */
  41     [property] boolean IsDate;
  42
  43     /** the is the content of this field.
  44     */
  45     [optional, property] com::sun::star::util::DateTime DateTimeValue;
  46
  47     /** this is the number format for this field
  48         @see com::sun::star::util::NumberFormatter
  49     */
  50     [optional, property] long NumberFormat;
  51
  52     /** this is the display format for this field.
  53         Depending on #IsDate, this
  54         is either a
  55         com::sun::star::text::DateDisplayFormat or
  56         com::sun::star::text::TimeDisplayFormat.
  57
  58         This property is deprecated and is here only
  59         for components that do not support a
  60         com::sun::star::util::NumberFormatter.
  61
  62         @see com::sun::star::text::DateDisplayFormat
  63         @see com::sun::star::text::TimeDisplayFormat
  64
  65         @deprecated
  66     */
  67     [optional, property] short DateTimeFormat;
  68     /** contains an offset to the date or time value in minutes.
  69     */
  70     [optional, property] long Adjust;
  71     /** determines whether changes in language attributes at the position the text field
  72         is located also change the number format as appropriate for this language.
  73      */
  74     [optional, property] boolean IsFixedLanguage;
  75 };
  76
  77
  78 }; }; }; }; };
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */