writerfilter/source/doctok/WW8BinTable.hxx

   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_BIN_TABLE_HXX
  21 #define INCLUDED_WW8_BIN_TABLE_HXX
  22
  23 #include <boost/shared_ptr.hpp>
  24 #include <string>
  25 #include <WW8FKP.hxx>
  26
  27 namespace writerfilter {
  28 namespace doctok
  29 {
  30
  31 /**
  32    A bintable.
  33
  34    Word uses bintables to associate FC ranges with FKPs. A bintable
  35    has a list of FCs. At each FC a range begins. The length of the
  36    range is given by the distance of the according CPs.
  37  */
  38 class WW8BinTable
  39 {
  40 public:
  41     virtual ~WW8BinTable() {};
  42     /**
  43        Shared pointer to a bintable.
  44      */
  45     typedef boost::shared_ptr<WW8BinTable> Pointer_t;
  46
  47     /**
  48        Return count of entries.
  49      */
  50     virtual sal_uInt32 getEntryCount() const = 0;
  51
  52     /**
  53        Return FC from bintable.
  54
  55        @param nIndex    index in bintable to return FC from
  56      */
  57     virtual Fc getFc(sal_uInt32 nIndex) const = 0;
  58
  59     /**
  60        Return page number.
  61
  62        @param nIndex    index in bintable to return page number from
  63      */
  64     virtual sal_uInt32 getPageNumber(sal_uInt32 nIndex) const = 0;
  65
  66     /**
  67        Return page number associated with FC.
  68
  69        @param rFc      FC to return page number for
  70      */
  71     virtual sal_uInt32 getPageNumber(const Fc & rFc) const = 0;
  72
  73     /**
  74        Return string representation of bintable.
  75      */
  76     virtual string toString() const = 0;
  77 };
  78 }}
  79
  80 #endif // INCLUDED_WW8_BIN_TABLE_HXX
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */