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