sw/inc/docstyle.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: docstyle.hxx,v $
  10  * $Revision: 1.10 $
  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 _DOCSTYLE_HXX
  31 #define _DOCSTYLE_HXX
  32
  33 #include <rtl/ref.hxx>
  34
  35 #ifndef _SVSTDARR_HXX
  36 #define _SVSTDARR_STRINGSDTOR
  37 #include <svtools/svstdarr.hxx>
  38 #endif
  39 #include <svtools/style.hxx>
  40 #include <svtools/itemset.hxx>
  41 #include "swdllapi.h"
  42
  43 class SwDoc;
  44 class SwDocStyleSheetPool;
  45 class SwPageDesc;
  46 class SwCharFmt;
  47 class SwTxtFmtColl;
  48 class SwFrmFmt;
  49 class SwNumRule;
  50
  51 /*--------------------------------------------------------------------
  52     Beschreibung:       Lokale Hilfsklasse
  53  --------------------------------------------------------------------*/
  54 class SwPoolFmtList : public SvStringsDtor
  55 {
  56 public:
  57     SwPoolFmtList() {}
  58     void Append( char cChar, const String& rStr );
  59     void Erase();
  60 };
  61
  62
  63 /*--------------------------------------------------------------------
  64     Beschreibung:       temp. StyleSheet
  65  --------------------------------------------------------------------*/
  66 class SW_DLLPUBLIC SwDocStyleSheet : public SfxStyleSheetBase
  67 {
  68     friend class SwDocStyleSheetPool;
  69     friend class SwStyleSheetIterator;
  70
  71     SwCharFmt*                  pCharFmt;
  72     SwTxtFmtColl*               pColl;
  73     SwFrmFmt*                   pFrmFmt;
  74     const SwPageDesc*   pDesc;
  75     const SwNumRule*    pNumRule;
  76
  77     SwDoc&                              rDoc;
  78     SfxItemSet                  aCoreSet;
  79
  80     BOOL                                bPhysical;
  81
  82
  83     // leere Huelse zum richtigen StyleSheet (Core) machen
  84     SW_DLLPRIVATE void                          Create();
  85
  86     // den StyleSheet mit Daten fuellen
  87     enum FillStyleType {
  88         FillOnlyName,
  89         FillAllInfo,
  90         FillPhysical
  91     };
  92
  93     SW_DLLPRIVATE BOOL FillStyleSheet( FillStyleType eFType );
  94
  95 protected:
  96     virtual ~SwDocStyleSheet();
  97
  98 public:
  99     SwDocStyleSheet( SwDoc&                             rDoc,
 100                      const String&                      rName,
 101                      SwDocStyleSheetPool&       rPool,
 102                      SfxStyleFamily             eFam,
 103                      USHORT                             nMask);
 104
 105     SwDocStyleSheet( const SwDocStyleSheet& );
 106
 107     void                                        Reset();
 108
 109     void                                        SetMask(USHORT nMsk)                    { nMask = nMsk;         }
 110     void                                        SetFamily(SfxStyleFamily eFam)  { nFamily = eFam;       }
 111
 112     BOOL                                        IsPhysical() const                              { return bPhysical; }
 113     void                                        SetPhysical(BOOL bPhys);
 114
 115     // --> OD 2008-02-11 #newlistlevelattrs#
 116     // add optional parameter <bResetIndentAttrsAtParagraphStyle>, default value FALSE,
 117     // which indicates that the indent attributes at a paragraph style should
 118     // be reset in case that a list style is applied to the paragraph style and
 119     // no indent attributes are applied.
 120     void                    SetItemSet( const SfxItemSet& rSet,
 121                                         const bool bResetIndentAttrsAtParagraphStyle = false );
 122     // <--
 123
 124     virtual SfxItemSet&         GetItemSet();
 125     // --> OD 2008-02-12 #newlistlevelattrs#
 126     // new method for paragraph styles to merge indent attributes of applied list
 127     // style into the given item set, if the list style indent attributes are applicable.
 128     void MergeIndentAttrsOfListStyle( SfxItemSet& rSet );
 129     // <--
 130     virtual const String&       GetParent() const;
 131     virtual const String&       GetFollow() const;
 132
 133     virtual ULONG GetHelpId( String& rFile );
 134     virtual void SetHelpId( const String& r, ULONG nId );
 135
 136     // Vorbelegen der member ohne physikalischen Zugriff
 137     // wird vom StyleSheetPool benutzt
 138     //
 139     void                                        PresetName(const String& rName)  { aName   = rName; }
 140     void                                        PresetNameAndFamily(const String& rName);
 141     void                                        PresetParent(const String& rName){ aParent = rName; }
 142     void                                        PresetFollow(const String& rName){ aFollow = rName; }
 143
 144     virtual BOOL                        SetName( const String& rStr);
 145     virtual BOOL                        SetParent( const String& rStr);
 146     virtual BOOL                        SetFollow( const String& rStr);
 147
 148     virtual BOOL                        HasFollowSupport() const;
 149     virtual BOOL                        HasParentSupport() const;
 150     virtual BOOL                        HasClearParentSupport() const;
 151     virtual String                      GetDescription();
 152     virtual String                      GetDescription(SfxMapUnit eUnit);
 153
 154     SwCharFmt*                          GetCharFmt();
 155     SwTxtFmtColl*                       GetCollection();
 156     SwFrmFmt*                           GetFrmFmt();
 157     const SwPageDesc*           GetPageDesc();
 158     const SwNumRule*            GetNumRule();
 159     void                                        SetNumRule(const SwNumRule& rRule);
 160
 161     virtual BOOL                        IsUsed() const;
 162 };
 163
 164 /*--------------------------------------------------------------------
 165     Beschreibung:       Iterator fuer den Pool
 166  --------------------------------------------------------------------*/
 167
 168 class SwStyleSheetIterator : public SfxStyleSheetIterator, public SfxListener
 169 {
 170     rtl::Reference< SwDocStyleSheet > mxIterSheet;
 171     rtl::Reference< SwDocStyleSheet > mxStyleSheet;
 172     SwPoolFmtList               aLst;
 173     USHORT                              nLastPos;
 174     BOOL                                bFirstCalled;
 175
 176     void                                AppendStyleList(const SvStringsDtor& rLst,
 177                                         BOOL    bUsed,
 178                                         USHORT  nSection,
 179                                         char    cType);
 180
 181 public:
 182     SwStyleSheetIterator( SwDocStyleSheetPool* pBase,
 183                           SfxStyleFamily eFam, USHORT n=0xFFFF );
 184     virtual ~SwStyleSheetIterator();
 185
 186     virtual USHORT Count();
 187     virtual SfxStyleSheetBase *operator[](USHORT nIdx);
 188     virtual SfxStyleSheetBase* First();
 189     virtual SfxStyleSheetBase* Next();
 190     virtual SfxStyleSheetBase* Find(const UniString& rStr);
 191
 192     virtual void Notify( SfxBroadcaster&, const SfxHint& );
 193 };
 194
 195 /*--------------------------------------------------------------------
 196     Beschreibung:       Pool fuer
 197  --------------------------------------------------------------------*/
 198
 199 class SwDocStyleSheetPool : public SfxStyleSheetBasePool
 200 {
 201     rtl::Reference< SwDocStyleSheet > mxStyleSheet;
 202     SwDoc&                              rDoc;
 203     BOOL                                bOrganizer : 1;         // TRUE: fuer den Organizer
 204
 205
 206     virtual SfxStyleSheetBase* Create( const String&, SfxStyleFamily, USHORT nMask);
 207     virtual SfxStyleSheetBase* Create( const SfxStyleSheetBase& );
 208
 209     using SfxStyleSheetBasePool::Find;
 210
 211 public:
 212     SwDocStyleSheetPool( SwDoc&, BOOL bOrganizer = FALSE );
 213
 214     virtual void Replace( SfxStyleSheetBase& rSource,
 215                           SfxStyleSheetBase& rTarget );
 216     virtual SfxStyleSheetBase& Make(const String&, SfxStyleFamily, USHORT nMask, USHORT nPos = 0xffff);
 217
 218     virtual SfxStyleSheetBase* Find( const String&, SfxStyleFamily eFam,
 219                                     USHORT n=0xFFFF );
 220
 221     virtual BOOL SetParent( SfxStyleFamily eFam, const String &rStyle,
 222                             const String &rParent );
 223
 224     virtual void Remove( SfxStyleSheetBase* pStyle);
 225
 226     void        SetOrganizerMode( BOOL bMode )  { bOrganizer = bMode; }
 227     BOOL        IsOrganizerMode() const                 { return bOrganizer; }
 228
 229     virtual SfxStyleSheetIterator* CreateIterator( SfxStyleFamily,
 230                                                     USHORT nMask );
 231
 232     SwDoc& GetDoc() const { return rDoc; }
 233
 234     void dispose();
 235
 236     virtual void SAL_CALL acquire(  ) throw ();
 237     virtual void SAL_CALL release(  ) throw ();
 238
 239 protected:
 240     virtual ~SwDocStyleSheetPool();
 241
 242     //Fuer die daemlicheren Compiler
 243 private:
 244     SwDocStyleSheetPool( const SwDocStyleSheetPool& );
 245 };
 246
 247
 248 #endif