sw/source/uibase/inc/content.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 #ifndef INCLUDED_SW_SOURCE_UIBASE_INC_CONTENT_HXX
  20 #define INCLUDED_SW_SOURCE_UIBASE_INC_CONTENT_HXX
  21 #include <memory>
  22 #include "swcont.hxx"
  23
  24 #include <ndarr.hxx>
  25
  26 class SwWrtShell;
  27 class SwContentArr;
  28 class SwContentType;
  29 class SwFormatField;
  30 class SwTextINetFormat;
  31 class SwTOXBase;
  32 class SwRangeRedline;
  33
  34 //  helper classes
  35
  36 class SwOutlineContent : public SwContent
  37 {
  38     SwOutlineNodes::size_type nOutlinePos;
  39     sal_uInt8   nOutlineLevel;
  40     bool    bIsMoveable;
  41     public:
  42         SwOutlineContent(   const SwContentType* pCnt,
  43                             const OUString& rName,
  44                             SwOutlineNodes::size_type nArrPos,
  45                             sal_uInt8 nLevel,
  46                             bool bMove,
  47                             tools::Long nYPos) :
  48             SwContent(pCnt, rName, nYPos),
  49             nOutlinePos(nArrPos), nOutlineLevel(nLevel), bIsMoveable(bMove) {}
  50
  51     SwOutlineNodes::size_type GetOutlinePos() const {return nOutlinePos;}
  52     sal_uInt8   GetOutlineLevel() const {return nOutlineLevel;}
  53     bool        IsMoveable() const {return bIsMoveable;};
  54 };
  55
  56 class SwRegionContent : public SwContent
  57 {
  58
  59     sal_uInt8   nRegionLevel;
  60
  61     public:
  62         SwRegionContent(    const SwContentType* pCnt,
  63                             const OUString& rName,
  64                             sal_uInt8 nLevel,
  65                             tools::Long nYPos) :
  66             SwContent(pCnt, rName, nYPos),
  67                         nRegionLevel(nLevel){}
  68     sal_uInt8   GetRegionLevel() const {return nRegionLevel;}
  69 };
  70
  71 class SwURLFieldContent : public SwContent
  72 {
  73     OUString sURL;
  74     const SwTextINetFormat* pINetAttr;
  75
  76 public:
  77     SwURLFieldContent(  const SwContentType* pCnt,
  78                             const OUString& rName,
  79                             const OUString& rURL,
  80                             const SwTextINetFormat* pAttr,
  81                             tools::Long nYPos )
  82         : SwContent( pCnt, rName, nYPos ), sURL( rURL ), pINetAttr( pAttr )
  83     {}
  84
  85     virtual bool        IsProtect() const override;
  86     const OUString&     GetURL()    const   { return sURL; }
  87     const SwTextINetFormat* GetINetAttr() const { return pINetAttr; }
  88 };
  89
  90 class SwPostItContent : public SwContent
  91 {
  92     const SwFormatField*     pField;
  93 public:
  94     SwPostItContent( const SwContentType* pCnt,
  95                             const OUString& rName,
  96                             const SwFormatField* pFormatField,
  97                             tools::Long nYPos )
  98         : SwContent(pCnt, rName, nYPos)
  99         , pField(pFormatField)
 100     {}
 101
 102     const SwFormatField* GetPostIt() const  { return pField; }
 103     virtual bool    IsProtect()     const override;
 104 };
 105
 106 class SwGraphicContent : public SwContent
 107 {
 108     OUString      sLink;
 109 public:
 110     SwGraphicContent(const SwContentType* pCnt, const OUString& rName, const OUString& rLink, tools::Long nYPos)
 111         : SwContent( pCnt, rName, nYPos ), sLink( rLink )
 112         {}
 113     virtual ~SwGraphicContent() override;
 114
 115     const OUString&   GetLink() const {return sLink;}
 116 };
 117
 118 class SwTOXBaseContent : public SwContent
 119 {
 120     const SwTOXBase* pBase;
 121 public:
 122     SwTOXBaseContent(const SwContentType* pCnt, const OUString& rName, tools::Long nYPos, const SwTOXBase& rBase)
 123         : SwContent( pCnt, rName, nYPos ), pBase(&rBase)
 124         {}
 125     virtual ~SwTOXBaseContent() override;
 126
 127     const SwTOXBase* GetTOXBase() const {return pBase;}
 128 };
 129
 130 /**
 131  * Content type, knows it's contents and the WrtShell.
 132  *
 133  * The class ContentType contains information to one type of content.
 134  * MemberArray is only populated if the content is requested by
 135  * GetMember. It is reloaded after Invalidate() only if the content
 136  * should be read again.
 137 */
 138 class SwContentType : public SwTypeNumber
 139 {
 140     SwWrtShell*         m_pWrtShell;
 141     std::unique_ptr<SwContentArr>
 142                         m_pMember;            // array for content
 143     OUString            m_sContentTypeName;   // name of content type
 144     OUString            m_sSingleContentTypeName; // name of content type, singular
 145     OUString            m_sTypeToken;         // attachment for URL
 146     size_t              m_nMemberCount;       // content count
 147     ContentTypeId       m_nContentType;       // content type's Id
 148     sal_uInt8           m_nOutlineLevel;
 149     bool                m_bDataValid :    1;
 150     bool                m_bEdit:          1;  // can this type be edited?
 151     bool                m_bDelete:        1;  // can this type be deleted?
 152 protected:
 153         static OUString     RemoveNewline(const OUString&);
 154 public:
 155         SwContentType(SwWrtShell* pParent, ContentTypeId nType, sal_uInt8 nLevel );
 156         virtual ~SwContentType() override;
 157
 158         void                Init(bool* pbInvalidateWindow = nullptr);
 159
 160         /** Fill the List of contents */
 161         void                FillMemberList(bool* pbLevelChanged = nullptr);
 162         size_t              GetMemberCount() const
 163                                 {return m_nMemberCount;};
 164         ContentTypeId       GetType() const {return m_nContentType;}
 165
 166         /** Deliver content, for that if necessary fill the list */
 167         const SwContent*    GetMember(size_t nIndex);
 168         const OUString&     GetName() const {return m_sContentTypeName;}
 169         const OUString&     GetSingleName() const {return m_sSingleContentTypeName;}
 170         const OUString&     GetTypeToken() const{return m_sTypeToken;}
 171
 172         void                SetOutlineLevel(sal_uInt8 nNew)
 173                             {
 174                                 m_nOutlineLevel = nNew;
 175                                 Invalidate();
 176                             }
 177
 178         void                Invalidate(); // only nMemberCount is read again
 179
 180         bool                IsEditable() const {return m_bEdit;}
 181         bool                IsDeletable() const {return m_bDelete;}
 182 };
 183
 184 #endif
 185
 186 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */