sc/source/filter/inc/unitconverter.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 <map>
  23 #include <vector>
  24 #include <o3tl/enumarray.hxx>
  25 #include "workbookhelper.hxx"
  26
  27 namespace com::sun::star {
  28     namespace util { struct Date; struct DateTime; }
  29 }
  30
  31 namespace oox::xls {
  32
  33 /** Units supported by the UnitConverter class. */
  34 enum class Unit
  35 {
  36     Inch,          /// Inches.
  37     Point,         /// Points.
  38     Twip,          /// Twips (1/20 point).
  39     Emu,           /// English Metric Unit (1/360,000 cm).
  40     ScreenX,       /// Horizontal screen pixels.
  41     ScreenY,       /// Vertical screen pixels.
  42     Digit,         /// Digit width of document default font.
  43     Space,         /// Space character width of document default font.
  44     LAST
  45 };
  46
  47 /** Helper class that provides functions to convert values from and to
  48     different units.
  49
  50     Provides functions to calculate the width of certain characters of the
  51     default font of the imported/exported document. The default font is always
  52     the first font in the styles font list, and is always referenced by the
  53     default cell style ("Normal" style in Excel) which is used by all empty
  54     unformatted cells in the document. To be able to calculate the character
  55     width correctly, the default font must be known, which is the case after
  56     the finalizeImport() or finalizeExport() functions have been called. Caller
  57     must make sure to not call the character width conversion functions before.
  58  */
  59 class UnitConverter : public WorkbookHelper
  60 {
  61 public:
  62     explicit            UnitConverter( const WorkbookHelper& rHelper );
  63
  64     /** Final processing after import of all style settings. */
  65     void                finalizeImport();
  66     /** Updates internal nulldate for date/serial conversion. */
  67     void                finalizeNullDate( const css::util::Date& rNullDate );
  68
  69     /** Converts the passed value between the passed units. */
  70     double              scaleValue( double fValue, Unit eFromUnit, Unit eToUnit ) const;
  71
  72     /** Converts the passed value to 1/100 millimeters. */
  73     sal_Int32           scaleToMm100( double fValue, Unit eUnit ) const;
  74     /** Converts the passed value from 1/100 millimeters to the passed unit. */
  75     double              scaleFromMm100( sal_Int32 nMm100, Unit eUnit ) const;
  76
  77     /** Returns the serial value of the passed datetime, based on current nulldate. */
  78     double              calcSerialFromDateTime( const css::util::DateTime& rDateTime ) const;
  79     /** Returns the datetime of the passed serial value, based on current nulldate. */
  80     css::util::DateTime calcDateTimeFromSerial( double fSerial ) const;
  81
  82     /** Returns a BIFF error code from the passed error string. */
  83     sal_uInt8           calcBiffErrorCode( const OUString& rErrorCode ) const;
  84
  85     /** Returns an error string from the passed BIFF error code. */
  86     OUString            calcErrorString( sal_uInt8 nErrorCode ) const;
  87
  88     /** Returns the conversion coefficient for the passed unit. */
  89     double              getCoefficient( Unit eUnit ) const;
  90
  91 private:
  92     /** Adds an error code to the internal maps. */
  93     void                addErrorCode( sal_uInt8 nErrorCode, const OUString& rErrorCode );
  94
  95 private:
  96     o3tl::enumarray<Unit, double> maCoeffs;           /// Coefficients for unit conversion.
  97     std::map<OUString, sal_uInt8>     maOoxErrCodes;      /// Maps error code strings to BIFF error constants.
  98     sal_Int32           mnNullDate;         /// Nulldate of this workbook (number of days since 0000-01-01).
  99 };
 100
 101 } // namespace oox::xls
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */