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