include/vcl/txtattr.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_VCL_TXTATTR_HXX
  21 #define INCLUDED_VCL_TXTATTR_HXX
  22
  23 #include <config_options.h>
  24 #include <tools/color.hxx>
  25 #include <tools/debug.hxx>
  26 #include <tools/fontenum.hxx>
  27 #include <vcl/dllapi.h>
  28 #include <memory>
  29
  30 namespace vcl { class Font; }
  31
  32 #define TEXTATTR_FONTCOLOR  1
  33 #define TEXTATTR_FONTWEIGHT 3
  34
  35 #define TEXTATTR_USER_START 1000 //start id for user defined text attributes
  36 #define TEXTATTR_PROTECTED  4
  37
  38
  39 class VCL_DLLPUBLIC TextAttrib
  40 {
  41 private:
  42     sal_uInt16 const        mnWhich;
  43
  44 protected:
  45                             TextAttrib( sal_uInt16 nWhich ) : mnWhich(nWhich) {}
  46                             TextAttrib( const TextAttrib& ) = default;
  47
  48 public:
  49
  50     virtual                 ~TextAttrib();
  51
  52     sal_uInt16              Which() const   { return mnWhich; }
  53     virtual void            SetFont( vcl::Font& rFont ) const = 0;
  54     virtual std::unique_ptr<TextAttrib> Clone() const = 0;
  55
  56     virtual bool            operator==( const TextAttrib& rAttr ) const = 0;
  57     bool                    operator!=( const TextAttrib& rAttr ) const
  58                                 { return !(*this == rAttr ); }
  59 };
  60
  61
  62 class VCL_DLLPUBLIC TextAttribFontColor final : public TextAttrib
  63 {
  64 private:
  65     Color   maColor;
  66
  67 public:
  68                             TextAttribFontColor( const Color& rColor );
  69
  70     const Color&            GetColor() const { return maColor; }
  71
  72     virtual void            SetFont( vcl::Font& rFont ) const override;
  73     virtual std::unique_ptr<TextAttrib> Clone() const override;
  74     virtual bool            operator==( const TextAttrib& rAttr ) const override;
  75
  76 };
  77
  78 class UNLESS_MERGELIBS_MORE(VCL_DLLPUBLIC) TextAttribFontWeight final : public TextAttrib
  79 {
  80 private:
  81     FontWeight  meWeight;
  82
  83 public:
  84                             TextAttribFontWeight( FontWeight eWeight );
  85
  86     virtual void            SetFont( vcl::Font& rFont ) const override;
  87     virtual std::unique_ptr<TextAttrib> Clone() const override;
  88     virtual bool            operator==( const TextAttrib& rAttr ) const override;
  89
  90     FontWeight getFontWeight() const { return meWeight; }
  91 };
  92
  93 class TextAttribProtect final : public TextAttrib
  94 {
  95 public:
  96                             TextAttribProtect();
  97
  98     virtual void            SetFont( vcl::Font& rFont ) const override;
  99     virtual std::unique_ptr<TextAttrib> Clone() const override;
 100     virtual bool            operator==( const TextAttrib& rAttr ) const override;
 101
 102 };
 103
 104
 105 class TextCharAttrib
 106 {
 107 private:
 108     std::unique_ptr<TextAttrib>
 109                     mpAttr;
 110     sal_Int32       mnStart;
 111     sal_Int32       mnEnd;
 112
 113 public:
 114                     TextCharAttrib( const TextAttrib& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 115                     TextCharAttrib( const TextCharAttrib& rTextCharAttrib );
 116
 117     const TextAttrib&   GetAttr() const         { return *mpAttr; }
 118
 119     sal_uInt16          Which() const               { return mpAttr->Which(); }
 120
 121     sal_Int32           GetStart() const            { return mnStart; }
 122     void                SetStart(sal_Int32 n)       { mnStart = n; }
 123
 124     sal_Int32           GetEnd() const              { return mnEnd; }
 125     void                SetEnd(sal_Int32 n)         { mnEnd = n; }
 126
 127     inline sal_Int32    GetLen() const;
 128
 129     inline void     MoveForward( sal_Int32 nDiff );
 130     inline void     MoveBackward( sal_Int32 nDiff );
 131
 132     inline void     Expand( sal_Int32 nDiff );
 133     inline void     Collaps( sal_Int32 nDiff );
 134
 135     inline bool     IsIn( sal_Int32 nIndex ) const;
 136     inline bool     IsInside( sal_Int32 nIndex ) const;
 137     inline bool     IsEmpty() const;
 138
 139 };
 140
 141 inline sal_Int32 TextCharAttrib::GetLen() const
 142 {
 143     DBG_ASSERT( mnEnd >= mnStart, "TextCharAttrib: nEnd < nStart!" );
 144     return mnEnd-mnStart;
 145 }
 146
 147 inline void TextCharAttrib::MoveForward( sal_Int32 nDiff )
 148 {
 149     DBG_ASSERT( nDiff <= SAL_MAX_INT32-mnEnd, "TextCharAttrib: MoveForward?!" );
 150     mnStart = mnStart + nDiff;
 151     mnEnd = mnEnd + nDiff;
 152 }
 153
 154 inline void TextCharAttrib::MoveBackward( sal_Int32 nDiff )
 155 {
 156     DBG_ASSERT( mnStart >= nDiff, "TextCharAttrib: MoveBackward?!" );
 157     mnStart = mnStart - nDiff;
 158     mnEnd = mnEnd - nDiff;
 159 }
 160
 161 inline void TextCharAttrib::Expand( sal_Int32 nDiff )
 162 {
 163     DBG_ASSERT( nDiff <= SAL_MAX_INT32-mnEnd, "TextCharAttrib: Expand?!" );
 164     mnEnd = mnEnd + nDiff;
 165 }
 166
 167 inline void TextCharAttrib::Collaps( sal_Int32 nDiff )
 168 {
 169     DBG_ASSERT( mnEnd-mnStart >= nDiff, "TextCharAttrib: Collaps?!" );
 170     mnEnd = mnEnd - nDiff;
 171 }
 172
 173 inline bool TextCharAttrib::IsIn( sal_Int32 nIndex ) const
 174 {
 175     return ( ( mnStart <= nIndex ) && ( mnEnd >= nIndex ) );
 176 }
 177
 178 inline bool TextCharAttrib::IsInside( sal_Int32 nIndex ) const
 179 {
 180     return ( ( mnStart < nIndex ) && ( mnEnd > nIndex ) );
 181 }
 182
 183 inline bool TextCharAttrib::IsEmpty() const
 184 {
 185     return mnStart == mnEnd;
 186 }
 187
 188 #endif // INCLUDED_VCL_TXTATTR_HXX
 189
 190 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */