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