sw/inc/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.39.78.1 $
  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 #include <tools/link.hxx>
  34 #include <tools/gen.hxx>
  35 #include <tools/string.hxx>
  36 #include <svx/svxenum.hxx>
  37 #include <svx/numitem.hxx>
  38 #include "swdllapi.h"
  39 #include <swtypes.hxx>
  40 #include <calbck.hxx>
  41 #include <errhdl.hxx>           // Fuer die inline-ASSERTs
  42 #include <error.h>                      // Fuer die inline-ASSERTs
  43 #include <hints.hxx>
  44 #include <hash_map>
  45 #include <stringhash.hxx>
  46 // --> OD 2008-02-21 #refactorlists#
  47 class SwNodeNum;
  48 #include <SwNumberTreeTypes.hxx>
  49 // <--
  50 // --> OD 2008-02-19 #refactorlists#
  51 #include <vector>
  52 class SwTxtFmtColl;
  53 // <--
  54 // --> OD 2008-07-08 #i91400#
  55 class IDocumentListsAccess;
  56 // <--
  57
  58 class Font;
  59 class SvxBrushItem;
  60 class SvxNumRule;
  61 class SwCharFmt;
  62 class SwDoc;
  63 class SwFmtVertOrient;
  64 class SwTxtNode;
  65
  66 const sal_Unicode cBulletChar   = 0x2022;       // Charakter fuer Aufzaehlungen
  67
  68 class SW_DLLPUBLIC SwNumFmt : public SvxNumberFormat, public SwClient
  69 {
  70     SwFmtVertOrient* pVertOrient;
  71
  72     SW_DLLPRIVATE void UpdateNumNodes( SwDoc* pDoc );
  73     SW_DLLPRIVATE virtual void NotifyGraphicArrived();
  74
  75     using SvxNumberFormat::operator ==;
  76     using SvxNumberFormat::operator !=;
  77
  78 public:
  79     SwNumFmt();
  80     SwNumFmt( const SwNumFmt& );
  81     SwNumFmt( const SvxNumberFormat&, SwDoc* pDoc);
  82
  83     virtual ~SwNumFmt();
  84
  85     SwNumFmt& operator=( const SwNumFmt& );
  86
  87     BOOL operator==( const SwNumFmt& ) const;
  88     BOOL operator!=( const SwNumFmt& r ) const { return !(*this == r); }
  89
  90     SwCharFmt* GetCharFmt() const { return (SwCharFmt*)pRegisteredIn; }
  91     void SetCharFmt( SwCharFmt* );
  92     virtual void Modify( SfxPoolItem* pOld, SfxPoolItem* pNew );
  93
  94     virtual void                        SetCharFmtName(const String& rSet);
  95     virtual const String&       GetCharFmtName()const;
  96
  97     virtual void    SetGraphicBrush( const SvxBrushItem* pBrushItem, const Size* pSize = 0, const sal_Int16* pOrient = 0);
  98
  99     virtual void                SetVertOrient(sal_Int16 eSet);
 100     virtual sal_Int16   GetVertOrient() const;
 101     const SwFmtVertOrient*      GetGraphicOrientation() const;
 102
 103     BOOL IsEnumeration() const; // #i22362#
 104     BOOL IsItemize() const; // #i29560#
 105 };
 106
 107 class SwPaM;
 108 enum SwNumRuleType { OUTLINE_RULE = 0, NUM_RULE = 1, RULE_END = 2 };
 109 class SW_DLLPUBLIC SwNumRule
 110 {
 111 // --> OD 2008-02-19 #refactorlists#
 112 public:
 113     typedef std::vector< SwTxtNode* > tTxtNodeList;
 114     typedef std::vector< SwTxtFmtColl* > tParagraphStyleList;
 115 // <--
 116 private:
 117     friend void _FinitCore();
 118
 119 #ifndef PRODUCT
 120     long int nSerial;
 121     static long int nInstances;
 122 #endif
 123
 124     static SwNumFmt* aBaseFmts [ RULE_END ][ MAXLEVEL ];
 125     static USHORT aDefNumIndents[ MAXLEVEL ];
 126     // --> OD 2008-02-11 #newlistlevelattrs#
 127     // default list level properties for position-and-space mode LABEL_ALIGNMENT
 128     static SwNumFmt* aLabelAlignmentBaseFmts [ RULE_END ][ MAXLEVEL ];
 129     // <--
 130     static USHORT nRefCount;
 131     static char* pDefOutlineName;
 132
 133     SwNumFmt* aFmts[ MAXLEVEL ];
 134
 135     /** container for associated text nodes
 136
 137     */
 138     // --> OD 2008-02-19 #refactorlists#
 139 //    SwTxtNodeTable* pTxtNodeList;
 140     tTxtNodeList maTxtNodeList;
 141     // <--
 142
 143     /** container for associated paragraph styles
 144
 145         OD 2008-03-03 #refactorlists#
 146     */
 147     tParagraphStyleList maParagraphStyleList;
 148
 149     // #i36749#
 150     /**
 151        hash_map containing "name->rule" relation
 152      */
 153     std::hash_map<String, SwNumRule *, StringHash> * pNumRuleMap;
 154
 155     String sName;
 156     SwNumRuleType eRuleType;
 157     USHORT nPoolFmtId;          // Id-fuer "automatich" erzeugte NumRules
 158     USHORT nPoolHelpId;         // HelpId fuer diese Pool-Vorlage
 159     BYTE nPoolHlpFileId;        // FilePos ans Doc auf die Vorlagen-Hilfen
 160     BOOL bAutoRuleFlag : 1;
 161     BOOL bInvalidRuleFlag : 1;
 162     BOOL bContinusNum : 1;      // Fortlaufende Numerierung - ohne Ebenen
 163     BOOL bAbsSpaces : 1;        // die Ebenen repraesentieren absol. Einzuege
 164     bool mbCountPhantoms;
 165
 166     // --> OD 2008-02-11 #newlistlevelattrs#
 167     const SvxNumberFormat::SvxNumPositionAndSpaceMode meDefaultNumberFormatPositionAndSpaceMode;
 168     // <--
 169
 170     // --> OD 2008-04-03 #refactorlists#
 171     String msDefaultListId;
 172     // <--
 173
 174     // forbidden and not implemented.
 175     SwNumRule();
 176
 177 public:
 178     // --> OD 2008-02-08 #newlistlevelattrs#
 179     // add parameter <eDefaultNumberFormatPositionAndSpaceMode>
 180     SwNumRule( const String& rNm,
 181                const SvxNumberFormat::SvxNumPositionAndSpaceMode eDefaultNumberFormatPositionAndSpaceMode,
 182                SwNumRuleType = NUM_RULE,
 183                BOOL bAutoFlg = TRUE );
 184
 185     SwNumRule( const SwNumRule& );
 186     ~SwNumRule();
 187
 188     SwNumRule& operator=( const SwNumRule& );
 189     BOOL operator==( const SwNumRule& ) const;
 190     BOOL operator!=( const SwNumRule& r ) const { return !(*this == r); }
 191
 192     const SwNumFmt* GetNumFmt( USHORT i ) const;
 193     const SwNumFmt& Get( USHORT i ) const;
 194
 195     void Set( USHORT i, const SwNumFmt* );
 196     void Set( USHORT i, const SwNumFmt& );
 197     String MakeNumString( const SwNodeNum&, BOOL bInclStrings = TRUE,
 198                             BOOL bOnlyArabic = FALSE ) const;
 199     // --> OD 2005-10-17 #126238#
 200     // - add optional parameter <_nRestrictToThisLevel> in order to
 201     //   restrict returned string to this level.
 202     String MakeNumString( const SwNumberTree::tNumberVector & rNumVector,
 203                           const BOOL bInclStrings = TRUE,
 204                           const BOOL bOnlyArabic = FALSE,
 205                           const unsigned int _nRestrictToThisLevel = MAXLEVEL ) const;
 206     // <--
 207     // --> OD 2007-08-24 #i81002#
 208     String MakeRefNumString( const SwNodeNum& rNodeNum,
 209                              const bool bInclSuperiorNumLabels = false,
 210                              const sal_uInt8 nRestrictInclToThisLevel = 0 ) const;
 211     // <--
 212
 213     /** Returns list of associated text nodes.
 214
 215        OD 2008-02-19 #refactorlists#
 216
 217        @return list of associated text nodes
 218     */
 219 //    const SwTxtNodeTable * GetTxtNodeList() const { return pTxtNodeList; }
 220     void GetTxtNodeList( SwNumRule::tTxtNodeList& rTxtNodeList ) const;
 221     SwNumRule::tTxtNodeList::size_type GetTxtNodeListSize() const;
 222
 223     // --> OD 2008-02-19 #refactorlists#
 224     void AddTxtNode( SwTxtNode& rTxtNode );
 225     void RemoveTxtNode( SwTxtNode& rTxtNode );
 226     // <--
 227
 228     // --> OD 2008-03-03 #refactorlists#
 229     SwNumRule::tParagraphStyleList::size_type GetParagraphStyleListSize() const;
 230     void AddParagraphStyle( SwTxtFmtColl& rTxtFmtColl );
 231     void RemoveParagraphStyle( SwTxtFmtColl& rTxtFmtColl );
 232     // <--
 233
 234     // --> OD 2008-04-03 #refactorlists#
 235     inline void SetDefaultListId( const String sDefaultListId )
 236     {
 237         msDefaultListId = sDefaultListId;
 238     }
 239     inline String GetDefaultListId() const
 240     {
 241         return msDefaultListId;
 242     }
 243     // <--
 244     // #i36749#
 245     /**
 246        Register this rule in a "name->numrule" map.
 247
 248        @param pNumRuleMap      map to register in
 249      */
 250     void SetNumRuleMap(
 251                 std::hash_map<String, SwNumRule *, StringHash>* pNumRuleMap );
 252
 253     static char* GetOutlineRuleName() { return pDefOutlineName; }
 254
 255     static USHORT GetNumIndent( BYTE nLvl );
 256     static USHORT GetBullIndent( BYTE nLvl );
 257
 258     SwNumRuleType GetRuleType() const                   { return eRuleType; }
 259     void SetRuleType( SwNumRuleType eNew )              { eRuleType = eNew;
 260                                                   bInvalidRuleFlag = TRUE; }
 261
 262     // eine Art Copy-Constructor, damit die Num-Formate auch an den
 263     // richtigen CharFormaten eines Dokumentes haengen !!
 264     // (Kopiert die NumFormate und returnt sich selbst)
 265     SwNumRule& CopyNumRule( SwDoc*, const SwNumRule& );
 266
 267     // testet ob die CharFormate aus dem angegeben Doc sind und kopiert
 268     // die gegebenfalls
 269     void CheckCharFmts( SwDoc* pDoc );
 270
 271     const String& GetName() const       { return sName; }
 272     // --> OD 2008-07-08 #i91400#
 273     void SetName( const String& rNm,
 274                   IDocumentListsAccess& rDocListAccess ); // #i36749#
 275     // <--
 276
 277     BOOL IsAutoRule() const                     { return bAutoRuleFlag; }
 278     void SetAutoRule( BOOL bFlag )              { bAutoRuleFlag = bFlag; }
 279
 280     BOOL IsInvalidRule() const                  { return bInvalidRuleFlag; }
 281     void SetInvalidRule( BOOL bFlag );
 282
 283     BOOL IsContinusNum() const                  { return bContinusNum; }
 284     void SetContinusNum( BOOL bFlag )   { bContinusNum = bFlag; }
 285
 286     BOOL IsAbsSpaces() const                    { return bAbsSpaces; }
 287     void SetAbsSpaces( BOOL bFlag )             { bAbsSpaces = bFlag; }
 288
 289     // #115901#
 290     BOOL IsOutlineRule() const { return eRuleType == OUTLINE_RULE; }
 291
 292     bool IsCountPhantoms() const;
 293     void SetCountPhantoms(bool bCountPhantoms);
 294
 295     // erfragen und setzen der Poolvorlagen-Id's
 296     USHORT GetPoolFmtId() const                 { return nPoolFmtId; }
 297     void SetPoolFmtId( USHORT nId )     { nPoolFmtId = nId; }
 298
 299     // erfragen und setzen der Hilfe-Id's fuer die Document-Vorlagen
 300     USHORT GetPoolHelpId() const                { return nPoolHelpId; }
 301     void SetPoolHelpId( USHORT nId )    { nPoolHelpId = nId; }
 302     BYTE GetPoolHlpFileId() const               { return nPoolHlpFileId; }
 303     void SetPoolHlpFileId( BYTE nId )   { nPoolHlpFileId = nId; }
 304
 305     void                SetSvxRule(const SvxNumRule&, SwDoc* pDoc);
 306     SvxNumRule  MakeSvxNumRule() const;
 307
 308     // #i23726#, #i23725#
 309     // --> OD 2008-06-09 #i90078#
 310     // refactoring: provide certain method for certain purpose
 311 //    void        Indent(short aAmount, int nLevel = -1,
 312 //                       int nReferenceLevel = -1, BOOL bRelative = TRUE,
 313 //                       BOOL bFirstLine = TRUE, BOOL bCheckGtZero = TRUE);
 314     // change indent of all list levels by given difference
 315     void ChangeIndent( const short nDiff );
 316     // set indent of certain list level to given value
 317     void SetIndent( const short nNewIndent,
 318                     const USHORT nListLevel );
 319     // set indent of first list level to given value and change other list level's
 320     // indents accordingly
 321     void SetIndentOfFirstListLevelAndChangeOthers( const short nNewIndent );
 322     // <--
 323
 324     void Validate();
 325 };
 326
 327 // --> OD 2006-06-27 #b6440955#
 328 // namespace for static functions and methods for numbering and bullets
 329 namespace numfunc
 330 {
 331     /** retrieve font family name used for the default bullet list characters
 332
 333         @author OD
 334     */
 335     const String& GetDefBulletFontname();
 336
 337     /** determine if default bullet font is user defined
 338
 339         OD 2008-06-06 #i63395#
 340         The default bullet font is user defined, if it is given in the user configuration
 341
 342         @author OD
 343     */
 344     bool IsDefBulletFontUserDefined();
 345
 346     /** retrieve font used for the default bullet list characters
 347
 348         @author OD
 349     */
 350     SW_DLLPUBLIC const Font& GetDefBulletFont();
 351
 352     /** retrieve unicode of character used for the default bullet list for the given list level
 353
 354         @author OD
 355     */
 356     sal_Unicode GetBulletChar( BYTE nLevel );
 357
 358     /** configuration, if at first position of the first list item the <TAB>-key
 359         increased the indent of the complete list or only demotes this list item.
 360         The same for <SHIFT-TAB>-key at the same position for decreasing the
 361         indent of the complete list or only promotes this list item.
 362
 363         OD 2007-10-01 #b6600435#
 364
 365         @author OD
 366     */
 367     sal_Bool ChangeIndentOnTabAtFirstPosOfFirstListItem();
 368
 369     /**
 370         OD 2008-06-06 #i89178#
 371
 372         @author OD
 373     */
 374     SvxNumberFormat::SvxNumPositionAndSpaceMode GetDefaultPositionAndSpaceMode();
 375 }
 376
 377 #endif  // _NUMRULE_HXX