editeng/inc/editattr.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 <editeng/eeitem.hxx>
  23 #include <svl/poolitem.hxx>
  24 #include <optional>
  25 #include <tools/color.hxx>
  26 #include <tools/debug.hxx>
  27
  28 class SvxFont;
  29 class SvxFontItem;
  30 class SvxWeightItem;
  31 class SvxPostureItem;
  32 class SvxShadowedItem;
  33 class SvxEscapementItem;
  34 class SvxContourItem;
  35 class SvxCrossedOutItem;
  36 class SvxUnderlineItem;
  37 class SvxOverlineItem;
  38 class SvxFontHeightItem;
  39 class SvxCharScaleWidthItem;
  40 class SvxColorItem;
  41 class SvxBackgroundColorItem;
  42 class SvxAutoKernItem;
  43 class SvxKerningItem;
  44 class SvxWordLineModeItem;
  45 class SvxFieldItem;
  46 class SvxLanguageItem;
  47 class SvxEmphasisMarkItem;
  48 class SvxCharReliefItem;
  49 class SfxVoidItem;
  50 class OutputDevice;
  51 class SvxCaseMapItem;
  52 class SfxGrabBagItem;
  53
  54 #define CH_FEATURE_OLD  (sal_uInt8)         0xFF
  55 #define CH_FEATURE      u'\x0001'
  56
  57 // DEF_METRIC: For my pool, the DefMetric should always appear when
  58 // GetMetric (nWhich)!
  59 // => To determine the DefMetric simply use GetMetric(0)
  60 #define DEF_METRIC  0
  61
  62
  63
  64 // bFeature: Attribute must not expand/shrink, length is always 1
  65 // bEdge: Attribute will not expand, if you want to expand just on the edge
  66 class EditCharAttrib
  67 {
  68     const SfxPoolItem*  pItem;
  69
  70     sal_Int32               nStart;
  71     sal_Int32               nEnd;
  72     bool                bFeature    :1;
  73     bool                bEdge       :1;
  74
  75 public:
  76     EditCharAttrib( const SfxPoolItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
  77     virtual ~EditCharAttrib();
  78
  79     EditCharAttrib(const EditCharAttrib&) = delete;
  80     EditCharAttrib& operator=(const EditCharAttrib&) = delete;
  81
  82     void                dumpAsXml(xmlTextWriterPtr pWriter) const;
  83
  84     sal_uInt16          Which() const   { return pItem->Which(); }
  85     const SfxPoolItem*  GetItem() const { return pItem; }
  86
  87     sal_Int32&          GetStart()                  { return nStart; }
  88     sal_Int32&          GetEnd()                    { return nEnd; }
  89
  90     sal_Int32           GetStart() const            { return nStart; }
  91     sal_Int32           GetEnd() const              { return nEnd; }
  92
  93     inline sal_Int32    GetLen() const;
  94
  95     inline void     MoveForward( sal_Int32 nDiff );
  96     inline void     MoveBackward( sal_Int32 nDiff );
  97
  98     inline void     Expand( sal_Int32 nDiff );
  99     inline void     Collaps( sal_Int32 nDiff );
 100
 101     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev );
 102
 103     bool    IsIn( sal_Int32 nIndex ) const
 104                 { return ( ( nStart <= nIndex ) && ( nEnd >= nIndex ) ); }
 105     bool    IsInside( sal_Int32 nIndex ) const
 106                 { return ( ( nStart < nIndex ) && ( nEnd > nIndex ) ); }
 107     bool        IsEmpty() const
 108                 { return nStart == nEnd; }
 109
 110     bool    IsFeature() const   { return bFeature; }
 111     void    SetFeature( bool b) { bFeature = b; }
 112
 113     bool    IsEdge() const      { return bEdge; }
 114     void    SetEdge( bool b )   { bEdge = b; }
 115 };
 116
 117 inline sal_Int32 EditCharAttrib::GetLen() const
 118 {
 119     DBG_ASSERT( nEnd >= nStart, "EditCharAttrib: nEnd < nStart!" );
 120     return nEnd-nStart;
 121 }
 122
 123 inline void EditCharAttrib::MoveForward( sal_Int32 nDiff )
 124 {
 125     DBG_ASSERT( SAL_MAX_INT32 - nDiff > nEnd, "EditCharAttrib: MoveForward?!" );
 126     nStart = nStart + nDiff;
 127     nEnd = nEnd + nDiff;
 128 }
 129
 130 inline void EditCharAttrib::MoveBackward( sal_Int32 nDiff )
 131 {
 132     DBG_ASSERT( (nStart - nDiff) >= 0, "EditCharAttrib: MoveBackward?!" );
 133     nStart = nStart - nDiff;
 134     nEnd = nEnd - nDiff;
 135 }
 136
 137 inline void EditCharAttrib::Expand( sal_Int32 nDiff )
 138 {
 139     DBG_ASSERT( SAL_MAX_INT32 - nDiff > nEnd, "EditCharAttrib: Expand?!" );
 140     DBG_ASSERT( !bFeature, "Please do not expand any features!" );
 141     nEnd = nEnd + nDiff;
 142 }
 143
 144 inline void EditCharAttrib::Collaps( sal_Int32 nDiff )
 145 {
 146     DBG_ASSERT( nEnd - nDiff >= nStart, "EditCharAttrib: Collaps?!" );
 147     DBG_ASSERT( !bFeature, "Please do not shrink any Features!" );
 148     nEnd = nEnd - nDiff;
 149 }
 150
 151
 152
 153 class EditCharAttribFont final : public EditCharAttrib
 154 {
 155 public:
 156     EditCharAttribFont( const SvxFontItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 157
 158     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 159 };
 160
 161
 162
 163 class EditCharAttribWeight final : public EditCharAttrib
 164 {
 165 public:
 166     EditCharAttribWeight( const SvxWeightItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 167
 168     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 169 };
 170
 171
 172 class EditCharAttribItalic final : public EditCharAttrib
 173 {
 174 public:
 175     EditCharAttribItalic( const SvxPostureItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 176
 177     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 178 };
 179
 180
 181
 182 class EditCharAttribShadow final : public EditCharAttrib
 183 {
 184 public:
 185     EditCharAttribShadow( const SvxShadowedItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 186
 187     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 188 };
 189
 190
 191
 192 class EditCharAttribEscapement final : public EditCharAttrib
 193 {
 194 public:
 195     EditCharAttribEscapement( const SvxEscapementItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 196
 197     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 198 };
 199
 200
 201
 202 class EditCharAttribOutline final : public EditCharAttrib
 203 {
 204 public:
 205     EditCharAttribOutline( const SvxContourItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 206
 207     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 208 };
 209
 210
 211
 212 class EditCharAttribStrikeout final : public EditCharAttrib
 213 {
 214 public:
 215     EditCharAttribStrikeout( const SvxCrossedOutItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 216
 217     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 218 };
 219
 220
 221
 222 class EditCharAttribCaseMap final : public EditCharAttrib
 223 {
 224 public:
 225     EditCharAttribCaseMap( const SvxCaseMapItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 226
 227     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 228 };
 229
 230
 231
 232 class EditCharAttribUnderline final : public EditCharAttrib
 233 {
 234 public:
 235     EditCharAttribUnderline( const SvxUnderlineItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 236
 237     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 238 };
 239
 240
 241
 242 class EditCharAttribOverline final : public EditCharAttrib
 243 {
 244 public:
 245     EditCharAttribOverline( const SvxOverlineItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 246
 247     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 248 };
 249
 250
 251
 252 class EditCharAttribEmphasisMark final : public EditCharAttrib
 253 {
 254 public:
 255     EditCharAttribEmphasisMark( const SvxEmphasisMarkItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 256
 257     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 258 };
 259
 260
 261
 262 class EditCharAttribRelief final : public EditCharAttrib
 263 {
 264 public:
 265     EditCharAttribRelief( const SvxCharReliefItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 266
 267     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 268 };
 269
 270
 271
 272 class EditCharAttribFontHeight final : public EditCharAttrib
 273 {
 274 public:
 275     EditCharAttribFontHeight( const SvxFontHeightItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 276
 277     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 278 };
 279
 280
 281
 282 class EditCharAttribFontWidth final : public EditCharAttrib
 283 {
 284 public:
 285     EditCharAttribFontWidth( const SvxCharScaleWidthItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 286
 287     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 288 };
 289
 290
 291
 292 class EditCharAttribColor final : public EditCharAttrib
 293 {
 294 public:
 295     EditCharAttribColor( const SvxColorItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 296
 297     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 298 };
 299
 300
 301 class EditCharAttribBackgroundColor final : public EditCharAttrib
 302 {
 303 public:
 304     EditCharAttribBackgroundColor(const SvxBackgroundColorItem& rAttr,
 305                                   sal_Int32 nStart,
 306                                   sal_Int32 nEnd );
 307     virtual void    SetFont(SvxFont& rFont, OutputDevice* pOutDev) override;
 308 };
 309
 310
 311
 312 class EditCharAttribLanguage final : public EditCharAttrib
 313 {
 314 public:
 315     EditCharAttribLanguage( const SvxLanguageItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 316
 317     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 318 };
 319
 320
 321
 322 class EditCharAttribTab final : public EditCharAttrib
 323 {
 324 public:
 325     EditCharAttribTab( const SfxVoidItem& rAttr, sal_Int32 nPos );
 326
 327     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 328 };
 329
 330
 331
 332 class EditCharAttribLineBreak final : public EditCharAttrib
 333 {
 334 public:
 335     EditCharAttribLineBreak( const SfxVoidItem& rAttr, sal_Int32 nPos );
 336
 337     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 338 };
 339
 340
 341
 342 class EditCharAttribField final : public EditCharAttrib
 343 {
 344     OUString   aFieldValue;
 345     std::optional<Color>  mxTxtColor;
 346     std::optional<Color>  mxFldColor;
 347
 348     EditCharAttribField& operator = ( const EditCharAttribField& rAttr ) = delete;
 349
 350 public:
 351     EditCharAttribField( const SvxFieldItem& rAttr, sal_Int32 nPos );
 352     EditCharAttribField( const EditCharAttribField& rAttr );
 353     virtual ~EditCharAttribField() override;
 354
 355     bool operator == ( const EditCharAttribField& rAttr ) const;
 356     bool operator != ( const EditCharAttribField& rAttr ) const
 357                                     { return !(operator == ( rAttr ) ); }
 358
 359     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 360     std::optional<Color>&   GetTextColor()      { return mxTxtColor; }
 361     std::optional<Color>&   GetFieldColor()     { return mxFldColor; }
 362
 363     const OUString& GetFieldValue() const { return aFieldValue;}
 364     void SetFieldValue(const OUString& rVal);
 365
 366     void Reset();
 367 };
 368
 369
 370
 371 class EditCharAttribPairKerning final : public EditCharAttrib
 372 {
 373 public:
 374     EditCharAttribPairKerning( const SvxAutoKernItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 375
 376     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 377 };
 378
 379
 380
 381 class EditCharAttribKerning final : public EditCharAttrib
 382 {
 383 public:
 384     EditCharAttribKerning( const SvxKerningItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 385
 386     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 387 };
 388
 389
 390
 391 class EditCharAttribWordLineMode final : public EditCharAttrib
 392 {
 393 public:
 394     EditCharAttribWordLineMode( const SvxWordLineModeItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 395
 396     virtual void    SetFont( SvxFont& rFont, OutputDevice* pOutDev ) override;
 397 };
 398
 399
 400 class EditCharAttribGrabBag final : public EditCharAttrib
 401 {
 402 public:
 403     EditCharAttribGrabBag( const SfxGrabBagItem& rAttr, sal_Int32 nStart, sal_Int32 nEnd );
 404 };
 405
 406
 407 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */