lotuswordpro/source/filter/lwpdivinfo.hxx

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