bump product version to 4.2.0.1
[LibreOffice.git] / include / unotools / fontcvt.hxx
blob2beda5d8a77b5a06e9b81a8ec833266c37a4c23c
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_UNOTOOLS_FONTCVT_HXX
21 #define INCLUDED_UNOTOOLS_FONTCVT_HXX
23 #include <unotools/unotoolsdllapi.h>
24 #include <rtl/ustring.hxx>
25 #include <tools/solar.h>
27 // ------------------
28 // - FontToSubsFont -
29 // ------------------
31 #define FONTTOSUBSFONT_IMPORT ((sal_uLong)0x00000001)
32 #define FONTTOSUBSFONT_EXPORT ((sal_uLong)0x00000002)
33 #define FONTTOSUBSFONT_ONLYOLDSOSYMBOLFONTS ((sal_uLong)0x00000004)
35 typedef void* FontToSubsFontConverter;
36 UNOTOOLS_DLLPUBLIC FontToSubsFontConverter CreateFontToSubsFontConverter( const OUString& rFontName, sal_uLong nFlags );
37 UNOTOOLS_DLLPUBLIC void DestroyFontToSubsFontConverter( FontToSubsFontConverter hConverter );
38 UNOTOOLS_DLLPUBLIC sal_Unicode ConvertFontToSubsFontChar( FontToSubsFontConverter hConverter, sal_Unicode c );
39 UNOTOOLS_DLLPUBLIC OUString GetFontToSubsFontName( FontToSubsFontConverter hConverter );
41 // ---------------------------
42 // - StarSymbolToMSMultiFont -
43 // ---------------------------
45 class UNOTOOLS_DLLPUBLIC StarSymbolToMSMultiFont
47 public:
48 //Returns the name of the best windows symbol font which this char can be
49 //mapped to. Sets rChar to the correct position for that font. If no
50 //match found, then no name is returned, and rChar is unchanged. If you
51 //want to convert a string, you don't want to use this.
52 virtual OUString ConvertChar(sal_Unicode &rChar) = 0;
54 //Starts converting the string at position rIndex. It converts as much of
55 //the string that can be converted to the same symbol font and returns the
56 //name of that font. rIndex is modified to the last index that was
57 //converted. Typically you call if continously until rIndex ==
58 //rString.Len() and handle each section as separate 8bit strings using
59 //separate fonts. Will return an empty string for a continous section
60 //that has no possible mapping.
61 virtual OUString ConvertString(OUString &rString, sal_Int32 &rIndex) = 0;
62 virtual ~StarSymbolToMSMultiFont() {}
65 //with bPerfect set the converter will only try and convert symbols which have
66 //perfect mappings to the windows symbols fonts. With it not set, it will
67 //allow somewhat more dubious transformations that are nevertheless
68 //recognizably similar. Even in this mode there will be characters that fail.
69 //The users of this might want to make a distinction between failed characters
70 //which were inside and those outside the unicode private area.
71 UNOTOOLS_DLLPUBLIC StarSymbolToMSMultiFont *CreateStarSymbolToMSMultiFont(bool bPerfectOnly=false);
72 #endif // INCLUDED_UNOTOOLS_FONTCVT_HXX
74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */