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 "lwpheader.hxx"
  65
  66 #define STYLE_USEONALLPAGES     0x0001U /* repeat on all pages */
  67 #define STYLE_USEONALLEVENPAGES 0x0002U /* repeat on all even pages */
  68 #define STYLE_USEONALLODDPAGES  0x0004U /* repeat on all odd pages */
  69 #define STYLE_USEONTHISPAGE     0x0008U /* use this guy on this page */
  70 #define STYLE_USEEXCEPTTHISPAGE 0x0010U /* use guy except on this page */
  71 #define STYLE_USESTARTINGONPAGE 0x0020U /* use starting on page n */
  72 #define STYLE_USEONMASK         (STYLE_USEONALLPAGES | \
  73                                     STYLE_USEONALLEVENPAGES | \
  74                                     STYLE_USEONALLODDPAGES | \
  75                                     STYLE_USEONTHISPAGE | \
  76                                     STYLE_USEEXCEPTTHISPAGE | \
  77                                     STYLE_USESTARTINGONPAGE)
  78
  79 #define STYLE_STARTONNEXTPAGE   0x0000U // This is the default
  80 #define STYLE_STARTONTHISPAGE   0x0040U
  81 #define STYLE_STARTONNEXTODD    0x0080U
  82 #define STYLE_STARTONNEXTEVEN   0x0100U
  83 #define STYLE_STARTONTHISHF     0x0200U
  84 #define STYLE_STARTONMASK       (STYLE_STARTONTHISPAGE | \
  85                                     STYLE_STARTONNEXTODD | \
  86                                     STYLE_STARTONNEXTEVEN | \
  87                                     STYLE_STARTONTHISHF)
  88 class LwpUseWhen
  89 {
  90 public:
  91     LwpUseWhen() : m_nFlags(0), m_nUsePage(0) {}
  92
  93     inline void Read(LwpObjectStream* pStrm);
  94
  95     inline bool IsUseOnAllPages();
  96     inline bool IsUseOnAllEvenPages();
  97     inline bool IsUseOnAllOddPages();
  98     inline bool IsUseOnPage();
  99
 100     inline bool IsStartOnThisPage();
 101     inline bool IsStartOnNextPage();
 102     inline bool IsStartOnNextEvenPage();
 103     inline bool IsStartOnNextOddPage();
 104     inline bool IsStartOnThisHF();
 105
 106     inline sal_uInt16 GetUsePage();
 107 private:
 108     sal_uInt16  m_nFlags;
 109     sal_uInt16  m_nUsePage;
 110 };
 111
 112 inline void LwpUseWhen::Read(LwpObjectStream* pStrm)
 113 {
 114     m_nFlags = pStrm->QuickReaduInt16();
 115     m_nUsePage = pStrm->QuickReaduInt16();
 116     pStrm->SkipExtra();
 117 }
 118 inline bool LwpUseWhen::IsUseOnAllPages()
 119 {
 120     return ((m_nFlags & STYLE_USEONALLPAGES) != 0);
 121 }
 122 inline bool LwpUseWhen::IsUseOnAllEvenPages()
 123 {
 124     return ((m_nFlags & STYLE_USEONALLEVENPAGES) != 0);
 125 }
 126 inline bool LwpUseWhen::IsUseOnAllOddPages()
 127 {
 128     return ((m_nFlags & STYLE_USEONALLODDPAGES) != 0);
 129 }
 130
 131 inline bool LwpUseWhen::IsUseOnPage()
 132 {
 133     return ((m_nFlags & STYLE_USEONTHISPAGE) != 0);
 134 }
 135
 136 inline bool LwpUseWhen::IsStartOnThisPage()
 137 {
 138     return ((m_nFlags & STYLE_STARTONTHISPAGE) != 0);
 139 }
 140
 141 inline bool LwpUseWhen::IsStartOnNextPage()
 142 {
 143     return ((m_nFlags & STYLE_STARTONMASK) == 0);
 144 }
 145
 146 inline bool LwpUseWhen::IsStartOnNextOddPage()
 147 {
 148     return ((m_nFlags & STYLE_STARTONNEXTODD) != 0);
 149 }
 150
 151 inline bool LwpUseWhen::IsStartOnNextEvenPage()
 152 {
 153     return ((m_nFlags & STYLE_STARTONNEXTEVEN) != 0);
 154 }
 155
 156 inline bool LwpUseWhen::IsStartOnThisHF()
 157 {
 158     return ((m_nFlags & STYLE_STARTONTHISHF) != 0);
 159 }
 160
 161 inline sal_uInt16 LwpUseWhen::GetUsePage()
 162 {
 163     return m_nUsePage;
 164 }
 165
 166 #endif
 167
 168 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */