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