include/svtools/scriptedtext.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 <svtools/svtdllapi.h>
  23 #include <rtl/ustring.hxx>
  24 #include <memory>
  25
  26
  27 namespace com :: sun :: star :: i18n { class XBreakIterator; }
  28 namespace com :: sun :: star :: uno { template <typename > class Reference; }
  29
  30 class OutputDevice;
  31 namespace vcl { class Font; }
  32 class SvtScriptedTextHelper_Impl;
  33 class Size;
  34 class Point;
  35
  36
  37 /**
  38 This class provides drawing text with different script types on any output devices.
  39 */
  40 class SVT_DLLPUBLIC SvtScriptedTextHelper final
  41 {
  42 private:
  43     std::unique_ptr<SvtScriptedTextHelper_Impl> mpImpl;             /// Implementation of class functionality.
  44
  45     SvtScriptedTextHelper&      operator=( const SvtScriptedTextHelper& ) = delete;
  46
  47 public:
  48                                 /** Constructor sets an output device and no fonts.
  49                                     @param  _rOutDevice
  50                                     A reference to an output device. */
  51                                 SvtScriptedTextHelper( OutputDevice& _rOutDevice );
  52
  53                                 /** Copy constructor. */
  54                                 SvtScriptedTextHelper(
  55                                     const SvtScriptedTextHelper& _rCopy );
  56
  57                                 /** Destructor. */
  58                                 ~SvtScriptedTextHelper();
  59
  60                                 /** Sets new fonts and recalculates the text width.
  61                                     @param  _pLatinFont
  62                                     The font for latin characters.
  63                                     @param  _pAsianFont
  64                                     The font for asian characters.
  65                                     @param  _pCmplxFont
  66                                     The font for complex text layout. */
  67     void                        SetFonts( vcl::Font const * _pLatinFont, vcl::Font const * _pAsianFont, vcl::Font const * _pCmplxFont );
  68
  69                                 /** Sets the default font of the current output device to all script types. */
  70     void                        SetDefaultFont();
  71
  72                                 /** Sets a new text and calculates all script breaks and the text width.
  73                                     @param  _rText
  74                                     The new text.
  75                                     @param  _xBreakIter
  76                                     The break iterator for iterating through the script portions. */
  77     void                        SetText(
  78                                     const OUString& _rText,
  79                                     const css::uno::Reference< css::i18n::XBreakIterator >& _xBreakIter );
  80
  81                                 /** Returns a size struct containing the width and height of the text in the current output device.
  82                                     @return  A size struct with the text dimensions. */
  83     const Size&                 GetTextSize() const;
  84
  85                                 /** Draws the text in the current output device.
  86                                     @param _rPos
  87                                     The position of the top left edge of the text. */
  88     void                        DrawText( const Point& _rPos );
  89 };
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */