offapi/com/sun/star/report/XFormattedField.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XFormattedField.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_report_XFormattedField_idl__
  31 #define __com_sun_star_report_XFormattedField_idl__
  32
  33 #ifndef __com_sun_star_report_XReportControlModel_idl__
  34 #include <com/sun/star/report/XReportControlModel.idl>
  35 #endif
  36 #ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
  37 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42  module com {  module sun {  module star {  module report {
  43
  44 //=============================================================================
  45 /** describes a control which can be used for displaying values with a arbitrary formatting.
  46
  47     @see com::sun::star::report::XReportControlModel
  48     @see com::sun::star::util::XNumberFormatsSupplier
  49 */
  50 interface XFormattedField
  51 {
  52     interface XReportControlModel;
  53
  54     /** specifies the format to be used when formatting the field input
  55         and output.
  56
  57         <p>This value is meaningful relative to the FormatsSupplier attribute
  58         only.</p>
  59      */
  60     [attribute,bound] long FormatKey;
  61
  62     /** supplies the formats the field should work with.
  63      */
  64     [attribute,bound] com::sun::star::util::XNumberFormatsSupplier FormatsSupplier;
  65 };
  66
  67 service FormattedField : XFormattedField;
  68 //=============================================================================
  69
  70 }; }; }; };
  71
  72 /*=============================================================================
  73
  74 =============================================================================*/
  75 #endif