svtools/inc/txtattr.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: txtattr.hxx,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _TXTATTR_HXX
  32 #define _TXTATTR_HXX
  33
  34 #include "svtools/svtdllapi.h"
  35 #include <tools/color.hxx>
  36 #include <vcl/vclenum.hxx>
  37 #include <tools/string.hxx>
  38 #include <tools/debug.hxx>
  39
  40 class Font;
  41
  42 #define TEXTATTR_INVALID        0
  43 #define TEXTATTR_FONTCOLOR      1
  44 #define TEXTATTR_HYPERLINK      2
  45 #define TEXTATTR_FONTWEIGHT     3
  46
  47 #define TEXTATTR_USER_START 1000 //start id for user defined text attributes
  48 #define TEXTATTR_PROTECTED  4
  49
  50
  51 class SVT_DLLPUBLIC TextAttrib
  52 {
  53 private:
  54     USHORT                                      mnWhich;
  55
  56 protected:
  57                             TextAttrib( USHORT nWhich ) { mnWhich = nWhich; }
  58                             TextAttrib( const TextAttrib& rAttr ) { mnWhich = rAttr.mnWhich; }
  59
  60 public:
  61
  62     virtual                                     ~TextAttrib();
  63
  64     USHORT                                      Which() const   { return mnWhich; }
  65
  66     virtual void                        SetFont( Font& rFont ) const = 0;
  67     virtual TextAttrib*         Clone() const = 0;
  68     virtual int                         operator==( const TextAttrib& rAttr ) const = 0;
  69     int                                         operator!=( const TextAttrib& rAttr ) const
  70                                 { return !(*this == rAttr ); }
  71 };
  72
  73
  74
  75 class SVT_DLLPUBLIC TextAttribFontColor : public TextAttrib
  76 {
  77 private:
  78     Color       maColor;
  79
  80 public:
  81                             TextAttribFontColor( const Color& rColor );
  82                             TextAttribFontColor( const TextAttribFontColor& rAttr );
  83                             ~TextAttribFontColor();
  84
  85     const Color&            GetColor() const { return maColor; }
  86
  87     virtual void                        SetFont( Font& rFont ) const;
  88     virtual TextAttrib*         Clone() const;
  89     virtual int                         operator==( const TextAttrib& rAttr ) const;
  90
  91 };
  92
  93 class SVT_DLLPUBLIC TextAttribFontWeight : public TextAttrib
  94 {
  95 private:
  96     FontWeight  meWeight;
  97
  98 public:
  99                             TextAttribFontWeight( FontWeight eWeight );
 100                             TextAttribFontWeight( const TextAttribFontWeight& rAttr );
 101                             ~TextAttribFontWeight();
 102
 103     virtual void                        SetFont( Font& rFont ) const;
 104     virtual TextAttrib*         Clone() const;
 105     virtual int                         operator==( const TextAttrib& rAttr ) const;
 106
 107     inline FontWeight getFontWeight() const { return meWeight; }
 108 };
 109
 110
 111 class TextAttribHyperLink : public TextAttrib
 112 {
 113 private:
 114     XubString   maURL;
 115     XubString   maDescription;
 116     Color               maColor;
 117
 118 public:
 119                             TextAttribHyperLink( const XubString& rURL );
 120                             TextAttribHyperLink( const XubString& rURL, const XubString& rDescription );
 121                             TextAttribHyperLink( const TextAttribHyperLink& rAttr );
 122                             ~TextAttribHyperLink();
 123
 124     void                                        SetURL( const XubString& rURL )                         { maURL = rURL; }
 125     const XubString&                    GetURL() const                                                          { return maURL; }
 126
 127     void                                        SetDescription( const XubString& rDescr )       { maDescription = rDescr; }
 128     const XubString&                    GetDescription() const                                          { return maDescription; }
 129
 130     void                                        SetColor( const Color& rColor )                         { maColor = rColor; }
 131     const Color&                        GetColor() const                                                        { return maColor; }
 132
 133     virtual void                        SetFont( Font& rFont ) const;
 134     virtual TextAttrib*         Clone() const;
 135     virtual int                         operator==( const TextAttrib& rAttr ) const;
 136 };
 137
 138 class SVT_DLLPUBLIC TextAttribProtect : public TextAttrib
 139 {
 140 public:
 141                             TextAttribProtect();
 142                             TextAttribProtect( const TextAttribProtect& rAttr );
 143                             ~TextAttribProtect();
 144
 145     virtual void            SetFont( Font& rFont ) const;
 146     virtual TextAttrib*     Clone() const;
 147     virtual int             operator==( const TextAttrib& rAttr ) const;
 148
 149 };
 150
 151
 152 class TextCharAttrib
 153 {
 154 private:
 155     TextAttrib*         mpAttr;
 156     USHORT                      mnStart;
 157     USHORT                      mnEnd;
 158
 159 protected:
 160
 161 public:
 162
 163                     TextCharAttrib( const TextAttrib& rAttr, USHORT nStart, USHORT nEnd );
 164                     TextCharAttrib( const TextCharAttrib& rTextCharAttrib );
 165                     ~TextCharAttrib();
 166
 167     const TextAttrib&   GetAttr() const                 { return *mpAttr; }
 168
 169     USHORT                      Which() const                           { return mpAttr->Which(); }
 170
 171     USHORT                      GetStart() const                        { return mnStart; }
 172     USHORT&                     GetStart()                                      { return mnStart; }
 173
 174     USHORT                      GetEnd() const                          { return mnEnd; }
 175     USHORT&                     GetEnd()                                        { return mnEnd; }
 176
 177     inline USHORT       GetLen() const;
 178
 179     inline void         MoveForward( USHORT nDiff );
 180     inline void         MoveBackward( USHORT nDiff );
 181
 182     inline void         Expand( USHORT nDiff );
 183     inline void         Collaps( USHORT nDiff );
 184
 185     inline BOOL         IsIn( USHORT nIndex );
 186     inline BOOL         IsInside( USHORT nIndex );
 187     inline BOOL         IsEmpty();
 188
 189 };
 190
 191 inline USHORT TextCharAttrib::GetLen() const
 192 {
 193     DBG_ASSERT( mnEnd >= mnStart, "TextCharAttrib: nEnd < nStart!" );
 194     return mnEnd-mnStart;
 195 }
 196
 197 inline void TextCharAttrib::MoveForward( USHORT nDiff )
 198 {
 199     DBG_ASSERT( ((long)mnEnd + nDiff) <= 0xFFFF, "TextCharAttrib: MoveForward?!" );
 200     mnStart = mnStart + nDiff;
 201     mnEnd = mnEnd + nDiff;
 202 }
 203
 204 inline void TextCharAttrib::MoveBackward( USHORT nDiff )
 205 {
 206     DBG_ASSERT( ((long)mnStart - nDiff) >= 0, "TextCharAttrib: MoveBackward?!" );
 207     mnStart = mnStart - nDiff;
 208     mnEnd = mnEnd - nDiff;
 209 }
 210
 211 inline void     TextCharAttrib::Expand( USHORT nDiff )
 212 {
 213     DBG_ASSERT( ( ((long)mnEnd + nDiff) <= (long)0xFFFF ), "TextCharAttrib: Expand?!" );
 214     mnEnd = mnEnd + nDiff;
 215 }
 216
 217 inline void     TextCharAttrib::Collaps( USHORT nDiff )
 218 {
 219     DBG_ASSERT( (long)mnEnd - nDiff >= (long)mnStart, "TextCharAttrib: Collaps?!" );
 220     mnEnd = mnEnd - nDiff;
 221 }
 222
 223 inline BOOL TextCharAttrib::IsIn( USHORT nIndex )
 224 {
 225     return ( ( mnStart <= nIndex ) && ( mnEnd >= nIndex ) );
 226 }
 227
 228 inline BOOL TextCharAttrib::IsInside( USHORT nIndex )
 229 {
 230     return ( ( mnStart < nIndex ) && ( mnEnd > nIndex ) );
 231 }
 232
 233 inline BOOL TextCharAttrib::IsEmpty()
 234 {
 235     return mnStart == mnEnd;
 236 }
 237
 238 #endif // _TXTATTR_HXX