offapi/com/sun/star/report/XFormattedField.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 #ifndef __com_sun_star_report_XFormattedField_idl__
  20 #define __com_sun_star_report_XFormattedField_idl__
  21
  22 #include <com/sun/star/report/XReportControlModel.idl>
  23 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  24
  25
  26  module com {  module sun {  module star {  module report {
  27
  28 /** describes a control which can be used for displaying values with a arbitrary formatting.
  29
  30     @see com::sun::star::report::XReportControlModel
  31     @see com::sun::star::util::XNumberFormatsSupplier
  32 */
  33 interface XFormattedField
  34 {
  35     interface XReportControlModel;
  36
  37     /** specifies the format to be used when formatting the field input
  38         and output.
  39
  40         <p>This value is meaningful relative to the FormatsSupplier attribute
  41         only.</p>
  42      */
  43     [attribute,bound] long FormatKey;
  44
  45     /** supplies the formats the field should work with.
  46      */
  47     [attribute,bound] com::sun::star::util::XNumberFormatsSupplier FormatsSupplier;
  48 };
  49
  50
  51 }; }; }; };
  52
  53 #endif
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */