binfilter/inc/bf_sw/numrule.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: numrule.hxx,v $
  10  * $Revision: 1.4 $
  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 #ifndef _NUMRULE_HXX
  31 #define _NUMRULE_HXX
  32
  33
  34 #ifndef _LINK_HXX //autogen
  35 #include <tools/link.hxx>
  36 #endif
  37 #ifndef _SV_GEN_HXX //autogen wg. Size
  38 #include <tools/gen.hxx>
  39 #endif
  40 #ifndef _STRING_HXX //autogen
  41 #include <tools/string.hxx>
  42 #endif
  43 #ifndef _SVX_SVXENUM_HXX //autogen
  44 #include <bf_svx/svxenum.hxx>
  45 #endif
  46
  47 #ifndef _SWTYPES_HXX
  48 #include <swtypes.hxx>
  49 #endif
  50 #ifndef _CALBCK_HXX
  51 #include <calbck.hxx>
  52 #endif
  53 #ifndef _ERRHDL_HXX
  54 #include <errhdl.hxx>           // Fuer die inline-ASSERTs
  55 #endif
  56 #ifndef _SWERROR_H
  57 #include <error.h>                      // Fuer die inline-ASSERTs
  58 #endif
  59 #ifndef _SVX_NUMITEM_HXX
  60 #include <bf_svx/numitem.hxx>
  61 #endif
  62 class Font;
  63 namespace binfilter {
  64
  65
  66 class SvxBrushItem;
  67 class SvxNumRule;
  68 class SwCharFmt;
  69 class SwDoc;
  70 class SwFmtVertOrient;
  71 class SwNodeNum;
  72 class SwTxtNode;
  73
  74 extern char __FAR_DATA sOutlineStr[];   // SWG-Filter
  75
  76 inline BYTE GetRealLevel( const BYTE nLvl )
  77 {
  78     return nLvl & (NO_NUMLEVEL - 1);
  79 }
  80 const sal_Unicode cBulletChar   = 0x2022;       // Charakter fuer Aufzaehlungen
  81
  82 class SwNumFmt : public SvxNumberFormat, public SwClient
  83 {
  84     SwFmtVertOrient* pVertOrient;
  85
  86     void UpdateNumNodes( SwDoc* pDoc );
  87     virtual void NotifyGraphicArrived();
  88 public:
  89     SwNumFmt();
  90     SwNumFmt( const SwNumFmt& );
  91     SwNumFmt( const SvxNumberFormat&, SwDoc* pDoc);
  92
  93     virtual ~SwNumFmt();
  94
  95     SwNumFmt& operator=( const SwNumFmt& );
  96     BOOL operator==( const SwNumFmt& ) const;
  97     BOOL operator!=( const SwNumFmt& r ) const { return !(*this == r); }
  98
  99     const Graphic* GetGraphic() const;
 100
 101     SwCharFmt* GetCharFmt() const { return (SwCharFmt*)pRegisteredIn; }
 102     void SetCharFmt( SwCharFmt* );
 103     virtual void Modify( SfxPoolItem* pOld, SfxPoolItem* pNew );
 104
 105     virtual void                        SetCharFmtName(const String& rSet);
 106     virtual const String&       GetCharFmtName()const;
 107
 108     virtual void        SetGraphicBrush( const SvxBrushItem* pBrushItem, const Size* pSize = 0, const SvxFrameVertOrient* pOrient = 0);
 109
 110     virtual void                                SetVertOrient(SvxFrameVertOrient eSet);
 111     virtual SvxFrameVertOrient  GetVertOrient() const;
 112     const SwFmtVertOrient*      GetGraphicOrientation() const;
 113 };
 114
 115 enum SwNumRuleType { OUTLINE_RULE = 0, NUM_RULE = 1, RULE_END = 2 };
 116 class SwNumRule
 117 {
 118     friend void _FinitCore();
 119
 120     static SwNumFmt* aBaseFmts [ RULE_END ][ MAXLEVEL ];
 121     static USHORT aDefNumIndents[ MAXLEVEL ];
 122     static USHORT nRefCount;
 123     static Font* pDefBulletFont;
 124     static char* pDefOutlineName;
 125
 126     SwNumFmt* aFmts[ MAXLEVEL ];
 127
 128     String sName;
 129     SwNumRuleType eRuleType;
 130     USHORT nPoolFmtId;          // Id-fuer "automatich" erzeugte NumRules
 131     USHORT nPoolHelpId;         // HelpId fuer diese Pool-Vorlage
 132     BYTE nPoolHlpFileId;        // FilePos ans Doc auf die Vorlagen-Hilfen
 133     BOOL bAutoRuleFlag : 1;
 134     BOOL bInvalidRuleFlag : 1;
 135     BOOL bContinusNum : 1;      // Fortlaufende Numerierung - ohne Ebenen
 136     BOOL bAbsSpaces : 1;        // die Ebenen repraesentieren absol. Einzuege
 137
 138     static void _MakeDefBulletFont();
 139
 140 public:
 141     SwNumRule( const String& rNm, SwNumRuleType = NUM_RULE,
 142                 BOOL bAutoFlg = TRUE );
 143
 144     SwNumRule( const SwNumRule& );
 145     ~SwNumRule();
 146
 147     SwNumRule& operator=( const SwNumRule& );
 148     BOOL operator==( const SwNumRule& ) const;
 149     BOOL operator!=( const SwNumRule& r ) const { return !(*this == r); }
 150
 151     inline const SwNumFmt* GetNumFmt( USHORT i ) const;
 152     inline const SwNumFmt& Get( USHORT i ) const;
 153     void Set( USHORT i, const SwNumFmt* );
 154     void Set( USHORT i, const SwNumFmt& );
 155     String MakeNumString( const SwNodeNum&, BOOL bInclStrings = TRUE,
 156                             BOOL bOnlyArabic = FALSE ) const;
 157
 158     inline sal_Unicode GetBulletChar( const SwNodeNum& ) const;
 159     inline const Font* GetBulletFont( const SwNodeNum& ) const;
 160     static inline const Font& GetDefBulletFont();
 161
 162     static char* GetOutlineRuleName() { return pDefOutlineName; }
 163
 164     static inline USHORT GetNumIndent( BYTE nLvl );
 165     static inline USHORT GetBullIndent( BYTE nLvl );
 166
 167     SwNumRuleType GetRuleType() const                   { return eRuleType; }
 168     void SetRuleType( SwNumRuleType eNew )              { eRuleType = eNew;
 169                                                   bInvalidRuleFlag = TRUE; }
 170
 171     // eine Art Copy-Constructor, damit die Num-Formate auch an den
 172     // richtigen CharFormaten eines Dokumentes haengen !!
 173     // (Kopiert die NumFormate und returnt sich selbst)
 174     SwNumRule& CopyNumRule( SwDoc*, const SwNumRule& );
 175
 176     // testet ob die CharFormate aus dem angegeben Doc sind und kopiert
 177     // die gegebenfalls
 178     void CheckCharFmts( SwDoc* pDoc );
 179
 180     // test ob der Einzug von dieser Numerierung kommt.
 181     BOOL IsRuleLSpace( SwTxtNode& rNd ) const;
 182
 183     const String& GetName() const               { return sName; }
 184     void SetName( const String& rNm )   { sName = rNm; }
 185
 186     BOOL IsAutoRule() const                     { return bAutoRuleFlag; }
 187     void SetAutoRule( BOOL bFlag )              { bAutoRuleFlag = bFlag; }
 188
 189     BOOL IsInvalidRule() const                  { return bInvalidRuleFlag; }
 190     void SetInvalidRule( BOOL bFlag )   { bInvalidRuleFlag = bFlag; }
 191
 192     BOOL IsContinusNum() const                  { return bContinusNum; }
 193     void SetContinusNum( BOOL bFlag )   { bContinusNum = bFlag; }
 194
 195     BOOL IsAbsSpaces() const                    { return bAbsSpaces; }
 196     void SetAbsSpaces( BOOL bFlag )             { bAbsSpaces = bFlag; }
 197
 198     // erfragen und setzen der Poolvorlagen-Id's
 199     USHORT GetPoolFmtId() const                 { return nPoolFmtId; }
 200     void SetPoolFmtId( USHORT nId )     { nPoolFmtId = nId; }
 201
 202     // erfragen und setzen der Hilfe-Id's fuer die Document-Vorlagen
 203     USHORT GetPoolHelpId() const                { return nPoolHelpId; }
 204     void SetPoolHelpId( USHORT nId )    { nPoolHelpId = nId; }
 205     BYTE GetPoolHlpFileId() const               { return nPoolHlpFileId; }
 206     void SetPoolHlpFileId( BYTE nId )   { nPoolHlpFileId = nId; }
 207
 208     /**
 209         #109308# Sets adjustment in all formats of the numbering rule.
 210
 211         @param eNum adjustment to be set
 212     */
 213     void SetNumAdjust(SvxAdjust eNum);
 214
 215     void                SetSvxRule(const SvxNumRule&, SwDoc* pDoc);
 216     SvxNumRule  MakeSvxNumRule() const;
 217 };
 218
 219
 220 class SwNodeNum
 221 {
 222     USHORT nLevelVal[ MAXLEVEL ];               // Nummern aller Levels
 223     USHORT nSetValue;                                   // vorgegeben Nummer
 224     BYTE nMyLevel;                                              // akt. Level
 225     BOOL bStartNum;                                             // Numerierung neu starten
 226
 227 public:
 228     inline SwNodeNum( BYTE nLevel = NO_NUM, USHORT nSetVal = USHRT_MAX );
 229     inline SwNodeNum& operator=( const SwNodeNum& rCpy );
 230
 231     BOOL operator==( const SwNodeNum& ) const;
 232
 233     BYTE GetLevel() const                                       { return nMyLevel; }
 234     void SetLevel( BYTE nVal )                          { nMyLevel = nVal; }
 235
 236     BOOL IsStart() const                                        { return bStartNum; }
 237     void SetStart( BOOL bFlag = TRUE )          { bStartNum = bFlag; }
 238
 239     USHORT GetSetValue() const                          { return nSetValue; }
 240     void SetSetValue( USHORT nVal )             { nSetValue = nVal; }
 241
 242     const USHORT* GetLevelVal() const           { return nLevelVal; }
 243           USHORT* GetLevelVal()                         { return nLevelVal; }
 244 };
 245
 246
 247
 248
 249 // ------------ inline Methoden ----------------------------
 250
 251 inline const SwNumFmt& SwNumRule::Get( USHORT i ) const
 252 {
 253     ASSERT_ID( i < MAXLEVEL && eRuleType < RULE_END, ERR_NUMLEVEL);
 254     return aFmts[ i ] ? *aFmts[ i ]
 255                       : *aBaseFmts[ eRuleType ][ i ];
 256 }
 257
 258 inline const SwNumFmt* SwNumRule::GetNumFmt( USHORT i ) const
 259 {
 260     ASSERT_ID( i < MAXLEVEL && eRuleType < RULE_END, ERR_NUMLEVEL);
 261     return aFmts[ i ];
 262 }
 263 inline const Font& SwNumRule::GetDefBulletFont()
 264 {
 265     if( !pDefBulletFont )
 266         SwNumRule::_MakeDefBulletFont();
 267     return *pDefBulletFont;
 268 }
 269
 270 inline USHORT SwNumRule::GetNumIndent( BYTE nLvl )
 271 {
 272     ASSERT( MAXLEVEL > nLvl, "NumLevel is out of range" );
 273     return aDefNumIndents[ nLvl ];
 274 }
 275 inline USHORT SwNumRule::GetBullIndent( BYTE nLvl )
 276 {
 277     ASSERT( MAXLEVEL > nLvl, "NumLevel is out of range" );
 278     return aDefNumIndents[ nLvl ];
 279 }
 280
 281 inline sal_Unicode SwNumRule::GetBulletChar( const SwNodeNum& rNum ) const
 282 {
 283     return Get( rNum.GetLevel() & ~NO_NUMLEVEL ).GetBulletChar();
 284 }
 285 inline const Font* SwNumRule::GetBulletFont( const SwNodeNum& rNum ) const
 286 {
 287     return Get( rNum.GetLevel() & ~NO_NUMLEVEL ).GetBulletFont();
 288 }
 289
 290
 291
 292 SwNodeNum::SwNodeNum( BYTE nLevel, USHORT nSetVal )
 293     : nSetValue( nSetVal ), nMyLevel( nLevel ), bStartNum( FALSE )
 294 {
 295     memset( nLevelVal, 0, sizeof( nLevelVal ) );
 296 }
 297
 298 inline SwNodeNum& SwNodeNum::operator=( const SwNodeNum& rCpy )
 299 {
 300     nSetValue = rCpy.nSetValue;
 301     nMyLevel = rCpy.nMyLevel;
 302     bStartNum = rCpy.bStartNum;
 303
 304     memcpy( nLevelVal, rCpy.nLevelVal, sizeof( nLevelVal ) );
 305     return *this;
 306 }
 307
 308
 309 } //namespace binfilter
 310 #endif  // _NUMRULE_HXX