writerfilter/source/doctok/WW8Sttbf.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: WW8Sttbf.hxx,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef INCLUDED_WW8_STTBF_HXX
  32 #define INCLUDED_WW8_STTBF_HXX
  33
  34 #include <WW8StructBase.hxx>
  35
  36 #include <boost/shared_ptr.hpp>
  37 #include <vector>
  38
  39 namespace writerfilter {
  40 namespace doctok
  41 {
  42
  43 using namespace ::std;
  44
  45 /**
  46    A string table in file.
  47
  48    The string table contains strings that each can have extra data.
  49  */
  50 class WW8Sttbf : public WW8StructBase
  51 {
  52     /// true if strings contain two-byte characters
  53     bool mbComplex;
  54
  55     /// the number of entries
  56     sal_uInt32 mnCount;
  57
  58     /// the size of the extra data (per string)
  59     sal_uInt32 mnExtraDataCount;
  60
  61     /// offsets for the strings
  62     vector<sal_uInt32> mEntryOffsets;
  63
  64     /// offsets for the extra data
  65     vector<sal_uInt32> mExtraOffsets;
  66
  67     /**
  68        Return offset of an entry.
  69
  70        @param nPos    the index of the entry
  71     */
  72     sal_uInt32 getEntryOffset(sal_uInt32 nPos) const;
  73
  74     /**
  75        Return offset of extra data of an entry.
  76
  77        @param nPos    the index of the entry
  78      */
  79     sal_uInt32 getExtraOffset(sal_uInt32 nPos) const;
  80
  81 public:
  82     typedef boost::shared_ptr<WW8Sttbf> Pointer_t;
  83
  84     WW8Sttbf(WW8Stream & rStream, sal_uInt32 nOffset, sal_uInt32 nCount);
  85
  86     /**
  87        Return the number of entries.
  88     */
  89     sal_uInt32 getEntryCount() const;
  90
  91     /**
  92        Return the string of an entry.
  93
  94        @param nPos     the index of the entry
  95      */
  96     rtl::OUString getEntry(sal_uInt32 nPos) const;
  97
  98     /**
  99        Return the extra data of an entry.
 100
 101        @param nPos     the index of the entry
 102     */
 103     WW8StructBase::Pointer_t getExtraData(sal_uInt32 nPos);
 104 };
 105 }}
 106 #endif // INCLUDED_WW8_STTBF