binfilter/inc/bf_svx/fhgtitem.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: fhgtitem.hxx,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _SVX_FHGTITEM_HXX
  31 #define _SVX_FHGTITEM_HXX
  32
  33 // include ---------------------------------------------------------------
  34
  35 #ifndef _SFXPOOLITEM_HXX //autogen
  36 #include <bf_svtools/poolitem.hxx>
  37 #endif
  38 #ifndef _SVX_SVXIDS_HRC
  39 #include <bf_svx/svxids.hrc>
  40 #endif
  41
  42 namespace rtl
  43 {
  44     class OUString;
  45 }
  46 namespace binfilter {
  47 class SvXMLUnitConverter;
  48 // class SvxFontHeightItem -----------------------------------------------
  49
  50 // Achtung: Twips-Werte
  51
  52 /*      [Beschreibung]
  53
  54     Dieses Item beschreibt die Font-Hoehe.
  55 */
  56
  57 #define FONTHEIGHT_16_VERSION   ((USHORT)0x0001)
  58 #define FONTHEIGHT_UNIT_VERSION ((USHORT)0x0002)
  59
  60 class SvxFontHeightItem : public SfxPoolItem
  61 {
  62     UINT32      nHeight;
  63     USHORT      nProp;                          // default 100%
  64     SfxMapUnit ePropUnit;               // Percent, Twip, ...
  65 public:
  66     TYPEINFO();
  67
  68     SvxFontHeightItem( const ULONG nSz = 240, const USHORT nPropHeight = 100,
  69                        const USHORT nId = ITEMID_FONTHEIGHT );
  70
  71     // "pure virtual Methoden" vom SfxPoolItem
  72     virtual int                          operator==( const SfxPoolItem& ) const;
  73     virtual     sal_Bool                 QueryValue( ::com::sun::star::uno::Any& rVal, BYTE nMemberId = 0 ) const;
  74     virtual     sal_Bool                         PutValue( const ::com::sun::star::uno::Any& rVal, BYTE nMemberId = 0 );
  75
  76
  77     virtual SfxPoolItem*         Clone( SfxItemPool *pPool = 0 ) const;
  78     virtual SfxPoolItem*     Create(SvStream &, USHORT) const;
  79     virtual SvStream&            Store(SvStream &, USHORT nItemVersion) const;
  80     virtual USHORT                       GetVersion( USHORT nItemVersion) const;
  81
  82     inline SvxFontHeightItem& operator=(const SvxFontHeightItem& rSize)
  83         {
  84             SetHeightValue( rSize.GetHeight() );
  85             SetProp( rSize.GetProp(), ePropUnit );
  86             return *this;
  87         }
  88
  89     void SetHeight( UINT32 nNewHeight, const USHORT nNewProp = 100,
  90                      SfxMapUnit eUnit = SFX_MAPUNIT_RELATIVE );
  91
  92
  93     UINT32 GetHeight() const { return nHeight; }
  94
  95     void SetHeightValue( UINT32 nNewHeight )
  96         {
  97             DBG_ASSERT( GetRefCount() == 0, "SetValue() with pooled item" );
  98             nHeight = nNewHeight;
  99         }
 100
 101     void SetProp( const USHORT nNewProp,
 102                     SfxMapUnit eUnit = SFX_MAPUNIT_RELATIVE )
 103         {
 104             DBG_ASSERT( GetRefCount() == 0, "SetValue() with pooled item" );
 105             nProp = nNewProp;
 106             ePropUnit = eUnit;
 107         }
 108
 109     USHORT GetProp() const { return nProp; }
 110
 111     SfxMapUnit GetPropUnit() const { return ePropUnit;  }       // Percent, Twip, ...
 112 };
 113
 114 }//end of namespace binfilter
 115 #endif
 116