include/filter/msfilter/util.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
  10 #ifndef INCLUDED_MSFILTER_UTIL_HXX
  11 #define INCLUDED_MSFILTER_UTIL_HXX
  12
  13 #include <rtl/textenc.h>
  14 #include <tools/datetime.hxx>
  15 #include <tools/color.hxx>
  16 #include <com/sun/star/lang/Locale.hpp>
  17 #include "filter/msfilter/msfilterdllapi.h"
  18 #include <com/sun/star/awt/Size.hpp>
  19
  20 namespace msfilter {
  21 namespace util {
  22
  23 /// Returns the best-fit default 8bit encoding for a given locale
  24 /// i.e. useful when dealing with legacy formats which use legacy text encodings without recording
  25 /// what the encoding is, but you know or can guess the language
  26 MSFILTER_DLLPUBLIC rtl_TextEncoding getBestTextEncodingFromLocale(const ::com::sun::star::lang::Locale &rLocale);
  27
  28 /// Convert a color in BGR format to RGB.
  29 MSFILTER_DLLPUBLIC sal_uInt32 BGRToRGB(sal_uInt32 nColour);
  30
  31 /** Convert from DTTM to Writer's DateTime
  32
  33   @author
  34   <a href="mailto:mmaher@openoffice.org">Martin Maher</a
  35   */
  36 MSFILTER_DLLPUBLIC DateTime DTTM2DateTime( long lDTTM );
  37
  38 /** Convert DateTime to xsd::dateTime string.
  39
  40 I guess there must be an implementation of this somewhere in LO, but I failed
  41 to find it, unfortunately :-(
  42 */
  43 MSFILTER_DLLPUBLIC OString DateTimeToOString( const DateTime& rDateTime );
  44
  45 /// Given a cBullet in encoding r_ioChrSet and fontname r_ioFontName return a
  46 /// suitable new Bullet and change r_ioChrSet and r_ioFontName to form the
  47 /// best-fit replacement in terms of default available MSOffice symbol
  48 /// fonts.
  49 ///
  50 /// Set bDisableUnicodeSupport when exporting to 8bit encodings
  51 ///
  52 /// Used to map from [Open|Star]Symbol to some Windows font or other.
  53 MSFILTER_DLLPUBLIC sal_Unicode bestFitOpenSymbolToMSFont(sal_Unicode cBullet,
  54     rtl_TextEncoding& r_ioChrSet, OUString& r_ioFontName, bool bDisableUnicodeSupport = false);
  55
  56
  57 enum TextCategory
  58 {
  59     latin,      //Latin
  60     cs,         //Complex Script
  61     ea,         //East Asian
  62     sym         //Symbol
  63 };
  64
  65 /** Categorize codepoints according to how MS seems to do it.
  66
  67   It's been bugging me for ages as to what codepoint MS considers in
  68   what category. Tom Jebo has a post suggesting the criteria used here
  69   and indicating its been submitting to the standards working group
  70   as a proposed resolution.
  71 */
  72 MSFILTER_DLLPUBLIC TextCategory categorizeCodePoint(sal_uInt32 codePoint, const OUString &rBcp47LanguageTag);
  73
  74 /// Converts tools Color to HTML color (without leading hashmark).
  75 MSFILTER_DLLPUBLIC OString ConvertColor( const Color &rColor );
  76
  77
  78 /** Paper size in 1/100 millimeters. */
  79 struct MSFILTER_DLLPUBLIC ApiPaperSize
  80 {
  81     sal_Int32           mnWidth;
  82     sal_Int32           mnHeight;
  83 };
  84
  85 class MSFILTER_DLLPUBLIC PaperSizeConv
  86 {
  87 public:
  88     static sal_Int32 getMSPaperSizeIndex( const com::sun::star::awt::Size& rSize );
  89     static const ApiPaperSize& getApiSizeForMSPaperSizeIndex( sal_Int32 nMSOPaperIndex );
  90 };
  91
  92 /**
  93  * Finds the quoted text in a field instruction text.
  94  *
  95  * Example: SEQ "Figure" \someoption -> "Figure"
  96  */
  97 MSFILTER_DLLPUBLIC OUString findQuotedText( const OUString& rCommand, const sal_Char* cStartQuote, const sal_Unicode uEndQuote );
  98 }
  99 }
 100
 101 #endif
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */