Branch data     Line data    Source code

       1                 :            : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2                 :            : /*
       3                 :            :  * This file is part of the LibreOffice project.
       4                 :            :  *
       5                 :            :  * This Source Code Form is subject to the terms of the Mozilla Public
       6                 :            :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7                 :            :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8                 :            :  *
       9                 :            :  * This file incorporates work covered by the following license notice:
      10                 :            :  *
      11                 :            :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12                 :            :  *   contributor license agreements. See the NOTICE file distributed
      13                 :            :  *   with this work for additional information regarding copyright
      14                 :            :  *   ownership. The ASF licenses this file to you under the Apache
      15                 :            :  *   License, Version 2.0 (the "License"); you may not use this file
      16                 :            :  *   except in compliance with the License. You may obtain a copy of
      17                 :            :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18                 :            :  */
      19                 :            : 
      20                 :            : #ifndef INCLUDED_WW8_FKP_HXX
      21                 :            : #define INCLUDED_WW8_FKP_HXX
      22                 :            : 
      23                 :            : #include <WW8CpAndFc.hxx>
      24                 :            : #include "WW8StructBase.hxx"
      25                 :            : 
      26                 :            : namespace writerfilter {
      27                 :            : namespace doctok
      28                 :            : {
      29                 :            : 
      30                 :            : /**
      31                 :            :    A formated diskpage (FKP).
      32                 :            : 
      33                 :            :    Formatted diskpages are used by Word to store runs of SPRMs (single
      34                 :            :    property modifier). A FKP contains a list of file character
      35                 :            :    positions (FC). For each FC there is an entry containing the run of
      36                 :            :    SPRMs stored for that FC.
      37                 :            :  */
      38         [ #  # ]:          0 : class WW8FKP : public WW8StructBase
      39                 :            : {
      40                 :            : public:
      41                 :            :     /**
      42                 :            :        Shared pointer to an FKP.
      43                 :            :      */
      44                 :            :     typedef boost::shared_ptr<WW8FKP> Pointer_t;
      45                 :            : 
      46                 :            :     /**
      47                 :            :        Create FKP from stream.
      48                 :            : 
      49                 :            :        @param rStream    stream to create FKP from
      50                 :            :        @param nOffset    offset in stream where the FKP starts.
      51                 :            :      */
      52                 :          0 :     WW8FKP(WW8Stream & rStream, sal_uInt32 nOffset)
      53                 :          0 :     : WW8StructBase(rStream, nOffset, 512)
      54                 :            :     {
      55                 :          0 :     }
      56                 :            : 
      57                 :            :     /**
      58                 :            :        Return count of entries.
      59                 :            :     */
      60                 :            :     virtual sal_uInt32 getEntryCount() const = 0;
      61                 :            : 
      62                 :            :     /**
      63                 :            :        Return an FC.
      64                 :            : 
      65                 :            :        @param nIndex   index of the FC to return
      66                 :            :      */
      67                 :            :     virtual Fc getFc(sal_uInt32 nIndex) const = 0;
      68                 :            : 
      69                 :            :     /**
      70                 :            :        Returns the first FC of the FKP.
      71                 :            :     */
      72                 :            :     virtual Fc getFirstFc() const = 0;
      73                 :            : 
      74                 :            :     /**
      75                 :            :        Returns the last FC of the FKP.
      76                 :            :      */
      77                 :            :     virtual Fc getLastFc() const = 0;
      78                 :            : 
      79                 :            :     /**
      80                 :            :        Check if an FKP contains an FC.
      81                 :            : 
      82                 :            :        @param rFc   FC to look for
      83                 :            : 
      84                 :            :        @retval true    FKP contains FC
      85                 :            :        @retval false   else
      86                 :            :      */
      87                 :            :     virtual bool contains(const Fc & rFc) const = 0;
      88                 :            : 
      89                 :            :     /**
      90                 :            :        Return properties stored in an FKP for a FC.
      91                 :            : 
      92                 :            :        @param rFc   FC to look for
      93                 :            :      */
      94                 :            :     virtual writerfilter::Reference<Properties>::Pointer_t
      95                 :            :     getProperties(const Fc & rFc)
      96                 :            :         const = 0;
      97                 :            : };
      98                 :            : 
      99                 :            : /**
     100                 :            :    Cache providing FKPs.
     101                 :            :  */
     102                 :          0 : class WW8FKPCache
     103                 :            : {
     104                 :            : public:
     105                 :            :     /**
     106                 :            :        Shared pointer to cache.
     107                 :            :      */
     108                 :            :     typedef boost::shared_ptr<WW8FKPCache> Pointer_t;
     109                 :            : 
     110                 :            :     virtual ~WW8FKPCache();
     111                 :            : 
     112                 :            :     /**
     113                 :            :        Return FKP.
     114                 :            : 
     115                 :            :        @param nPageNumber    number of page to return
     116                 :            :      */
     117                 :            :     virtual WW8FKP::Pointer_t get(sal_uInt32 nPageNumber, bool bComplex) = 0;
     118                 :            : };
     119                 :            : }}
     120                 :            : 
     121                 :            : #endif // INCLUDED_WW8_FKP_HXX
     122                 :            : 
     123                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */