lotuswordpro/source/filter/lwpusewhen.hxx

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