lotuswordpro/source/filter/lwpdivinfo.hxx

   1 /*************************************************************************
   2  *
   3  *  The Contents of this file are made available subject to the terms of
   4  *  either of the following licenses
   5  *
   6  *         - GNU Lesser General Public License Version 2.1
   7  *         - Sun Industry Standards Source License Version 1.1
   8  *
   9  *  Sun Microsystems Inc., October, 2000
  10  *
  11  *  GNU Lesser General Public License Version 2.1
  12  *  =============================================
  13  *  Copyright 2000 by Sun Microsystems, Inc.
  14  *  901 San Antonio Road, Palo Alto, CA 94303, USA
  15  *
  16  *  This library is free software; you can redistribute it and/or
  17  *  modify it under the terms of the GNU Lesser General Public
  18  *  License version 2.1, as published by the Free Software Foundation.
  19  *
  20  *  This library is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  23  *  Lesser General Public License for more details.
  24  *
  25  *  You should have received a copy of the GNU Lesser General Public
  26  *  License along with this library; if not, write to the Free Software
  27  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  28  *  MA  02111-1307  USA
  29  *
  30  *
  31  *  Sun Industry Standards Source License Version 1.1
  32  *  =================================================
  33  *  The contents of this file are subject to the Sun Industry Standards
  34  *  Source License Version 1.1 (the "License"); You may not use this file
  35  *  except in compliance with the License. You may obtain a copy of the
  36  *  License at http://www.openoffice.org/license.html.
  37  *
  38  *  Software provided under this License is provided on an "AS IS" basis,
  39  *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
  40  *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
  41  *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
  42  *  See the License for the specific provisions governing your rights and
  43  *  obligations concerning the Software.
  44  *
  45  *  The Initial Developer of the Original Code is: IBM Corporation
  46  *
  47  *  Copyright: 2008 by IBM Corporation
  48  *
  49  *  All Rights Reserved.
  50  *
  51  *  Contributor(s): _______________________________________
  52  *
  53  *
  54  ************************************************************************/
  55 /*************************************************************************
  56  * @file
  57  *  For LWP filter architecture prototype
  58  ************************************************************************/
  59 /*************************************************************************
  60  * Change History
  61  Jan 2005                       Created
  62  ************************************************************************/
  63
  64 #ifndef _LWPDIVINFO_HXX
  65 #define _LWPDIVINFO_HXX
  66
  67 #include "lwpobj.hxx"
  68 #include "lwpobjid.hxx"
  69 #include "lwpatomholder.hxx"
  70 #include "lwpcolor.hxx"
  71 #include "lwpheader.hxx"
  72 #include "lwpdoc.hxx"
  73
  74 #define STR_OleDivisionClassName        "OLEDivision"
  75
  76
  77 class LwpDivInfo : public LwpObject
  78 {
  79 public:
  80         LwpDivInfo(LwpObjectHeader& objHdr, LwpSvStream* pStrm);
  81         ~LwpDivInfo();
  82         LwpObjectID* GetInitialLayoutID(){ return &m_InitialLayoutID;}
  83         LwpObjectID* GetFillerPageTextID(){ return &m_FillerPageTextID;}
  84         // add by  ,03/14/2004
  85         rtl::OUString GetDivName() { return m_Name.str(); }
  86         // end add
  87
  88         rtl::OUString GetClassName() { return m_ClassName.str(); }
  89         inline sal_Bool HasContents();
  90         inline sal_Bool IsOleDivision();
  91         inline sal_Bool IsScrollable();
  92         inline sal_Bool IsGotoable();
  93         inline LwpDocument* GetDivision();
  94         void GetNumberOfPages(sal_uInt16& nPageno);
  95         sal_uInt16 GetMaxNumberOfPages();
  96         LwpAtomHolder* GetExternalName(){return &m_ExternalName;};
  97 protected:
  98         void Read();
  99 private:
 100         LwpObjectID m_ParentID;
 101         LwpAtomHolder m_Name;
 102         LwpObjectID m_LayoutID;
 103         sal_uInt16 m_nFlags;
 104         LwpAtomHolder m_ExternalName;
 105         LwpAtomHolder m_ExternalType;
 106         LwpAtomHolder m_ClassName;
 107         LwpObjectID m_InitialLayoutID;
 108         //pCDLVOListHeadHolder cPresInfo;
 109
 110         sal_uInt16 m_nPageNoStyle;
 111         LwpColor m_TabColor;
 112         LwpObjectID m_FillerPageTextID;
 113
 114         enum
 115         {
 116                 DI_SCROLLABLE = 0x01,
 117                 DI_HASCONTENTS = 0x02,
 118                 DI_EXPANDED = 0x04,
 119                 DI_SHOWSTAB = 0x08,
 120
 121                 DI_MUDPUPPY = 0x10,
 122                 DI_NOTDELETABLE = 0x20,
 123                 DI_BEGINGROUP = 0x40,
 124                 DI_GROUP = 0x80,
 125
 126                 DI_ENDGROUP = 0x100,
 127                 DI_SUPPRESS_FILLER_PAGE_HEADERS = 0x200,
 128                 DI_EXTERNALFILE = 0x400,
 129                 DI_FIXED = 0x800,
 130
 131                 DI_KNOWIFANYOLEDDELINKS = 0x1000,
 132                 DI_ANYOLEDDELINKS = 0x2000
 133         };
 134
 135         void SkipFront();
 136
 137 };
 138
 139 inline sal_Bool LwpDivInfo::HasContents()
 140 {
 141         return (m_nFlags & DI_HASCONTENTS) ? sal_True : sal_False;
 142 }
 143
 144 inline sal_Bool LwpDivInfo::IsOleDivision()
 145 {
 146         OUString strClassName = GetClassName();
 147         if (strClassName.equals(A2OUSTR(STR_OleDivisionClassName)))
 148                 return sal_True;
 149         return sal_False;
 150 }
 151
 152 inline sal_Bool LwpDivInfo::IsScrollable()
 153 {
 154         return (m_nFlags & DI_SCROLLABLE) ? sal_True : sal_False;
 155 }
 156
 157 inline sal_Bool LwpDivInfo::IsGotoable()
 158 {
 159         return HasContents() && (IsScrollable() || IsOleDivision());
 160 }
 161
 162 inline LwpDocument* LwpDivInfo::GetDivision()
 163 {
 164         return static_cast<LwpDocument*>(m_ParentID.obj());
 165 }
 166 #endif