offapi/com/sun/star/util/XNumberFormatPreviewer.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
  22  module com {  module sun {  module star {  module util {
  23
  24
  25 /** represents a number formatter which can preview number
  26     formats without inserting them.
  27
  28     @see NumberFormatter
  29  */
  30 published interface XNumberFormatPreviewer: com::sun::star::uno::XInterface
  31 {
  32
  33     /** formats a value using a format string, without inserting a
  34         number format into the list.
  35
  36         @param aFormat
  37             is the format string that is used for formatting.
  38
  39         @param fValue
  40             is the value that is formatted.
  41
  42         @param nLocale
  43             is the locale that is used to interpret the format string.
  44
  45         @param bAllowEnglish
  46             specifies if English language number format strings are accepted
  47             in addition to those from the selected locale.
  48
  49         @returns
  50             the formatted string.
  51
  52         @throws com::sun::star::util::MalformedNumberFormatException
  53             if the format string is invalid.
  54
  55      */
  56     string convertNumberToPreviewString( [in] string aFormat,
  57              [in] double fValue,
  58              [in] com::sun::star::lang::Locale nLocale,
  59              [in] boolean bAllowEnglish )
  60             raises( com::sun::star::util::MalformedNumberFormatException );
  61
  62
  63     /** returns the color which is to be used for a number.
  64
  65         @param aFormat
  66             is the format string that is used for formatting.
  67
  68         @param fValue
  69             is the value that is formatted.
  70
  71         @param nLocale
  72             is the locale that is used to interpret the format string.
  73
  74         @param bAllowEnglish
  75             specifies if English language number format strings are accepted
  76             in addition to those from the selected locale.
  77
  78         @param aDefaultColor
  79             is the color that should be returned if no color is set by
  80             the number format.
  81
  82         @returns
  83             the color that should used to output the formatted string.
  84
  85         @throws com::sun::star::util::MalformedNumberFormatException
  86             if the format string is invalid.
  87
  88      */
  89     com::sun::star::util::Color queryPreviewColorForNumber( [in] string aFormat,
  90              [in] double fValue,
  91              [in] com::sun::star::lang::Locale nLocale,
  92              [in] boolean bAllowEnglish,
  93              [in] com::sun::star::util::Color aDefaultColor )
  94             raises( com::sun::star::util::MalformedNumberFormatException );
  95
  96 };
  97
  98
  99 }; }; }; };
 100
 101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */