lotuswordpro/source/filter/lwpusewhen.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  The Contents of this file are made available subject to the terms of
   5  *  either of the following licenses
   6  *
   7  *         - GNU Lesser General Public License Version 2.1
   8  *         - Sun Industry Standards Source License Version 1.1
   9  *
  10  *  Sun Microsystems Inc., October, 2000
  11  *
  12  *  GNU Lesser General Public License Version 2.1
  13  *  =============================================
  14  *  Copyright 2000 by Sun Microsystems, Inc.
  15  *  901 San Antonio Road, Palo Alto, CA 94303, USA
  16  *
  17  *  This library is free software; you can redistribute it and/or
  18  *  modify it under the terms of the GNU Lesser General Public
  19  *  License version 2.1, as published by the Free Software Foundation.
  20  *
  21  *  This library is distributed in the hope that it will be useful,
  22  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24  *  Lesser General Public License for more details.
  25  *
  26  *  You should have received a copy of the GNU Lesser General Public
  27  *  License along with this library; if not, write to the Free Software
  28  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  29  *  MA  02111-1307  USA
  30  *
  31  *
  32  *  Sun Industry Standards Source License Version 1.1
  33  *  =================================================
  34  *  The contents of this file are subject to the Sun Industry Standards
  35  *  Source License Version 1.1 (the "License"); You may not use this file
  36  *  except in compliance with the License. You may obtain a copy of the
  37  *  License at http://www.openoffice.org/license.html.
  38  *
  39  *  Software provided under this License is provided on an "AS IS" basis,
  40  *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
  41  *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
  42  *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
  43  *  See the License for the specific provisions governing your rights and
  44  *  obligations concerning the Software.
  45  *
  46  *  The Initial Developer of the Original Code is: IBM Corporation
  47  *
  48  *  Copyright: 2008 by IBM Corporation
  49  *
  50  *  All Rights Reserved.
  51  *
  52  *  Contributor(s): _______________________________________
  53  *
  54  *
  55  ************************************************************************/
  56 /*************************************************************************
  57  * @file
  58  *  For LWP filter architecture prototype
  59  ************************************************************************/
  60
  61 #ifndef INCLUDED_LOTUSWORDPRO_SOURCE_FILTER_LWPUSEWHEN_HXX
  62 #define INCLUDED_LOTUSWORDPRO_SOURCE_FILTER_LWPUSEWHEN_HXX
  63
  64 #include <config_lgpl.h>
  65 #include <lwpobjstrm.hxx>
  66
  67 #define STYLE_USEONALLPAGES     0x0001U /* repeat on all pages */
  68 #define STYLE_USEONALLEVENPAGES 0x0002U /* repeat on all even pages */
  69 #define STYLE_USEONALLODDPAGES  0x0004U /* repeat on all odd pages */
  70 #define STYLE_USEONTHISPAGE     0x0008U /* use this guy on this page */
  71 #define STYLE_USEEXCEPTTHISPAGE 0x0010U /* use guy except on this page */
  72 #define STYLE_USESTARTINGONPAGE 0x0020U /* use starting on page n */
  73 #define STYLE_USEONMASK         (STYLE_USEONALLPAGES | \
  74                                     STYLE_USEONALLEVENPAGES | \
  75                                     STYLE_USEONALLODDPAGES | \
  76                                     STYLE_USEONTHISPAGE | \
  77                                     STYLE_USEEXCEPTTHISPAGE | \
  78                                     STYLE_USESTARTINGONPAGE)
  79
  80 #define STYLE_STARTONNEXTPAGE   0x0000U // This is the default
  81 #define STYLE_STARTONTHISPAGE   0x0040U
  82 #define STYLE_STARTONNEXTODD    0x0080U
  83 #define STYLE_STARTONNEXTEVEN   0x0100U
  84 #define STYLE_STARTONTHISHF     0x0200U
  85 #define STYLE_STARTONMASK       (STYLE_STARTONTHISPAGE | \
  86                                     STYLE_STARTONNEXTODD | \
  87                                     STYLE_STARTONNEXTEVEN | \
  88                                     STYLE_STARTONTHISHF)
  89 class LwpUseWhen
  90 {
  91 public:
  92     LwpUseWhen() : m_nFlags(0), m_nUsePage(0) {}
  93
  94     inline void Read(LwpObjectStream* pStrm);
  95
  96     inline bool IsUseOnAllPages() const;
  97     inline bool IsUseOnAllEvenPages() const;
  98     inline bool IsUseOnAllOddPages() const;
  99     inline bool IsUseOnPage() const;
 100
 101     inline bool IsStartOnThisPage() const;
 102     inline bool IsStartOnNextPage() const;
 103     inline bool IsStartOnNextEvenPage() const;
 104     inline bool IsStartOnNextOddPage() const;
 105     inline bool IsStartOnThisHF() const;
 106
 107     inline sal_uInt16 GetUsePage() const;
 108 private:
 109     sal_uInt16  m_nFlags;
 110     sal_uInt16  m_nUsePage;
 111 };
 112
 113 inline void LwpUseWhen::Read(LwpObjectStream* pStrm)
 114 {
 115     m_nFlags = pStrm->QuickReaduInt16();
 116     m_nUsePage = pStrm->QuickReaduInt16();
 117     pStrm->SkipExtra();
 118 }
 119 inline bool LwpUseWhen::IsUseOnAllPages() const
 120 {
 121     return ((m_nFlags & STYLE_USEONALLPAGES) != 0);
 122 }
 123 inline bool LwpUseWhen::IsUseOnAllEvenPages() const
 124 {
 125     return ((m_nFlags & STYLE_USEONALLEVENPAGES) != 0);
 126 }
 127 inline bool LwpUseWhen::IsUseOnAllOddPages() const
 128 {
 129     return ((m_nFlags & STYLE_USEONALLODDPAGES) != 0);
 130 }
 131
 132 inline bool LwpUseWhen::IsUseOnPage() const
 133 {
 134     return ((m_nFlags & STYLE_USEONTHISPAGE) != 0);
 135 }
 136
 137 inline bool LwpUseWhen::IsStartOnThisPage() const
 138 {
 139     return ((m_nFlags & STYLE_STARTONTHISPAGE) != 0);
 140 }
 141
 142 inline bool LwpUseWhen::IsStartOnNextPage() const
 143 {
 144     return ((m_nFlags & STYLE_STARTONMASK) == 0);
 145 }
 146
 147 inline bool LwpUseWhen::IsStartOnNextOddPage() const
 148 {
 149     return ((m_nFlags & STYLE_STARTONNEXTODD) != 0);
 150 }
 151
 152 inline bool LwpUseWhen::IsStartOnNextEvenPage() const
 153 {
 154     return ((m_nFlags & STYLE_STARTONNEXTEVEN) != 0);
 155 }
 156
 157 inline bool LwpUseWhen::IsStartOnThisHF() const
 158 {
 159     return ((m_nFlags & STYLE_STARTONTHISHF) != 0);
 160 }
 161
 162 inline sal_uInt16 LwpUseWhen::GetUsePage() const
 163 {
 164     return m_nUsePage;
 165 }
 166
 167 #endif
 168
 169 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */