/************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2008 by Sun Microsystems, Inc. * * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: WW8FKP.hxx,v $ * $Revision: 1.4 $ * * This file is part of OpenOffice.org. * * OpenOffice.org is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License version 3 * only, as published by the Free Software Foundation. * * OpenOffice.org is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License version 3 for more details * (a copy is included in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU Lesser General Public License * version 3 along with OpenOffice.org. If not, see * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef INCLUDED_WW8_FKP_HXX #define INCLUDED_WW8_FKP_HXX #ifndef INCLUDES_WW8_CP_AND_FC_HXX #include #endif #ifndef INCLUDE_WW8_STRUCT_BASE_HXX #include #endif namespace writerfilter { namespace doctok { /** A formated diskpage (FKP). Formatted diskpages are used by Word to store runs of SPRMs (single property modifier). A FKP contains a list of file character positions (FC). For each FC there is an entry containing the run of SPRMs stored for that FC. */ class WW8FKP : public WW8StructBase { public: /** Shared pointer to an FKP. */ typedef boost::shared_ptr Pointer_t; /** Create FKP from stream. @param rStream stream to create FKP from @param nOffset offset in stream where the FKP starts. */ WW8FKP(WW8Stream & rStream, sal_uInt32 nOffset) : WW8StructBase(rStream, nOffset, 512) { } /** Return count of entries. */ virtual sal_uInt32 getEntryCount() const = 0; /** Return an FC. @param nIndex index of the FC to return */ virtual Fc getFc(sal_uInt32 nIndex) const = 0; /** Returns the first FC of the FKP. */ virtual Fc getFirstFc() const = 0; /** Returns the last FC of the FKP. */ virtual Fc getLastFc() const = 0; /** Check if an FKP contains an FC. @param rFc FC to look for @retval true FKP contains FC @retval false else */ virtual bool contains(const Fc & rFc) const = 0; /** Return properties stored in an FKP for a FC. @param rFc FC to look for */ virtual writerfilter::Reference::Pointer_t getProperties(const Fc & rFc) const = 0; }; /** Cache providing FKPs. */ class WW8FKPCache { public: /** Shared pointer to cache. */ typedef boost::shared_ptr Pointer_t; virtual ~WW8FKPCache(); /** Return FKP. @param nPageNumber number of page to return */ virtual WW8FKP::Pointer_t get(sal_uInt32 nPageNumber, bool bComplex) = 0; }; }} #endif // INCLUDED_WW8_FKP_HXX