include/vcl/embeddedfontshelper.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_VCL_EMBEDDEDFONTSHELPER_HXX
  11 #define INCLUDED_VCL_EMBEDDEDFONTSHELPER_HXX
  12
  13 #include <vcl/dllapi.h>
  14
  15 #include <com/sun/star/io/XInputStream.hpp>
  16 #include <com/sun/star/uno/Reference.hxx>
  17 #include <rtl/ustring.hxx>
  18 #include <tools/fontenum.hxx>
  19 #include <vector>
  20
  21 /**
  22  Helper functions for handling embedded fonts in documents.
  23
  24 */
  25 class VCL_DLLPUBLIC EmbeddedFontsHelper
  26 {
  27 public:
  28     /// Specification of what kind of operation is allowed when embedding a font
  29     enum FontRights
  30     {
  31         ViewingAllowed, ///< Font may be embedded for viewing the document (but not editing)
  32         EditingAllowed ///< Font may be embedded for editing document (implies viewing)
  33     };
  34
  35     /**
  36       Returns URL for a font file for the given font, or empty if it does not exist.
  37     */
  38     static OUString fontFileUrl( const OUString& familyName, FontFamily family, FontItalic italic,
  39         FontWeight weight, FontPitch pitch, rtl_TextEncoding encoding, FontRights rights );
  40
  41     /**
  42       Reads a font from the input stream, saves it to a temporary font file and activates the font.
  43       @param stream stream of font data
  44       @param fontName name of the font (e.g. 'Times New Roman')
  45       @param extra additional text to use for name (e.g. to distinguish regular from bold, italic,...), "?" for unique
  46       @param key key to xor the data with, from the start until the key's length (not repeated)
  47       @param eot whether the data is compressed in Embedded OpenType format
  48     */
  49     static bool addEmbeddedFont( com::sun::star::uno::Reference< com::sun::star::io::XInputStream > stream,
  50         const OUString& fontName, const char* extra,
  51         std::vector< unsigned char > key = std::vector< unsigned char >(), bool eot = false);
  52
  53     /**
  54       Returns an URL for a file where to store contents of a given temporary font.
  55       The file may or not may not exist yet, and will be cleaned up automatically as appropriate.
  56       Use activateTemporaryFont() to actually enable usage of the font.
  57
  58       @param fontName name of the font (e.g. 'Times New Roman')
  59       @param extra additional text to use for name (e.g. to distinguish regular from bold, italic,...), "?" for unique
  60     */
  61     static OUString fileUrlForTemporaryFont( const OUString& fontName, const char* extra );
  62
  63     /**
  64       Adds the given font to the list of known fonts. The font is used only until application
  65       exit.
  66
  67       @param fontName name of the font (e.g. 'Times New Roman')
  68       @param fileUrl URL of the font file
  69     */
  70     static void activateFont( const OUString& fontName, const OUString& fileUrl );
  71
  72     /**
  73       Returns if the restrictions specified in the font (if present) allow embedding
  74       the font for a particular purpose.
  75       @param data font data
  76       @param size size of the font data
  77       @param rights type of operation to be allowed for the font
  78     */
  79     static bool sufficientTTFRights( const void* data, long size, FontRights rights );
  80
  81     /**
  82       Removes all temporary fonts in the path used by fileUrlForTemporaryFont().
  83       @internal
  84     */
  85     static void clearTemporaryFontFiles();
  86 };
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */