sc/inc/cellform.hxx

   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 #pragma once
  21
  22 #include "scdllapi.h"
  23 #include <rtl/ustring.hxx>
  24 #include <svl/sharedstring.hxx>
  25
  26 class SvNumberFormatter;
  27 class Color;
  28 class ScDocument;
  29 class ScAddress;
  30 struct ScRefCellValue;
  31
  32 class SC_DLLPUBLIC ScCellFormat
  33 {
  34 public:
  35
  36     static OUString GetString(
  37         const ScRefCellValue& rCell, sal_uInt32 nFormat,
  38         const Color** ppColor, SvNumberFormatter& rFormatter, const ScDocument& rDoc, bool bNullVals = true,
  39         bool bFormula  = false, bool bUseStarFormat = false );
  40
  41     static OUString GetString(
  42         ScDocument& rDoc, const ScAddress& rPos, sal_uInt32 nFormat,
  43         const Color** ppColor, SvNumberFormatter& rFormatter, bool bNullVals = true,
  44         bool bFormula  = false );
  45
  46     // Note that if pShared is set and a value is returned that way, the returned OUString is empty.
  47     static OUString GetInputString(
  48         const ScRefCellValue& rCell, sal_uInt32 nFormat, SvNumberFormatter& rFormatter,
  49         const ScDocument& rDoc, const svl::SharedString** pShared = nullptr, bool bFiltering = false,
  50         bool bForceSystemLocale = false );
  51
  52     static OUString GetInputString(
  53         const ScRefCellValue& rCell, sal_uInt32 nFormat, SvNumberFormatter& rFormatter,
  54         const ScDocument& rDoc, bool bFiltering, bool bForceSystemLocale = false )
  55     {
  56         return GetInputString( rCell, nFormat, rFormatter, rDoc, nullptr, bFiltering, bForceSystemLocale );
  57     }
  58
  59     static OUString GetOutputString(
  60         ScDocument& rDoc, const ScAddress& rPos, const ScRefCellValue& rCell );
  61 };
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */