writerfilter/source/doctok/WW8FKP.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: WW8FKP.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_FKP_HXX
  32 #define INCLUDED_WW8_FKP_HXX
  33
  34 #ifndef INCLUDES_WW8_CP_AND_FC_HXX
  35 #include <WW8CpAndFc.hxx>
  36 #endif
  37 #ifndef INCLUDE_WW8_STRUCT_BASE_HXX
  38 #include <WW8StructBase.hxx>
  39 #endif
  40
  41 namespace writerfilter {
  42 namespace doctok
  43 {
  44
  45 /**
  46    A formated diskpage (FKP).
  47
  48    Formatted diskpages are used by Word to store runs of SPRMs (single
  49    property modifier). A FKP contains a list of file character
  50    positions (FC). For each FC there is an entry containing the run of
  51    SPRMs stored for that FC.
  52  */
  53 class WW8FKP : public WW8StructBase
  54 {
  55 public:
  56     /**
  57        Shared pointer to an FKP.
  58      */
  59     typedef boost::shared_ptr<WW8FKP> Pointer_t;
  60
  61     /**
  62        Create FKP from stream.
  63
  64        @param rStream    stream to create FKP from
  65        @param nOffset    offset in stream where the FKP starts.
  66      */
  67     WW8FKP(WW8Stream & rStream, sal_uInt32 nOffset)
  68     : WW8StructBase(rStream, nOffset, 512)
  69     {
  70     }
  71
  72     /**
  73        Return count of entries.
  74     */
  75     virtual sal_uInt32 getEntryCount() const = 0;
  76
  77     /**
  78        Return an FC.
  79
  80        @param nIndex   index of the FC to return
  81      */
  82     virtual Fc getFc(sal_uInt32 nIndex) const = 0;
  83
  84     /**
  85        Returns the first FC of the FKP.
  86     */
  87     virtual Fc getFirstFc() const = 0;
  88
  89     /**
  90        Returns the last FC of the FKP.
  91      */
  92     virtual Fc getLastFc() const = 0;
  93
  94     /**
  95        Check if an FKP contains an FC.
  96
  97        @param rFc   FC to look for
  98
  99        @retval true    FKP contains FC
 100        @retval false   else
 101      */
 102     virtual bool contains(const Fc & rFc) const = 0;
 103
 104     /**
 105        Return properties stored in an FKP for a FC.
 106
 107        @param rFc   FC to look for
 108      */
 109     virtual writerfilter::Reference<Properties>::Pointer_t
 110     getProperties(const Fc & rFc)
 111         const = 0;
 112 };
 113
 114 /**
 115    Cache providing FKPs.
 116  */
 117 class WW8FKPCache
 118 {
 119 public:
 120     /**
 121        Shared pointer to cache.
 122      */
 123     typedef boost::shared_ptr<WW8FKPCache> Pointer_t;
 124
 125     virtual ~WW8FKPCache();
 126
 127     /**
 128        Return FKP.
 129
 130        @param nPageNumber    number of page to return
 131      */
 132     virtual WW8FKP::Pointer_t get(sal_uInt32 nPageNumber, bool bComplex) = 0;
 133 };
 134 }}
 135
 136 #endif // INCLUDED_WW8_FKP_HXX