binfilter/inc/bf_sw/fmtruby.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: fmtruby.hxx,v $
  10  * $Revision: 1.9 $
  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 _FMTRUBY_HXX
  31 #define _FMTRUBY_HXX
  32
  33
  34 #ifndef _SFXPOOLITEM_HXX
  35 #include <bf_svtools/poolitem.hxx>
  36 #endif
  37 namespace binfilter {
  38
  39 class SwTxtRuby;
  40
  41 class SwFmtRuby : public SfxPoolItem
  42 {
  43     friend class SwTxtRuby;
  44
  45     String sRubyTxt;                                    // the ruby txt
  46     String sCharFmtName;                                // name of the charformat
  47     SwTxtRuby* pTxtAttr;                                // the TextAttribut
  48     USHORT nCharFmtId;                                  // PoolId of the charformat
  49     USHORT nPosition;                                   // Position of the Ruby-Character
  50     USHORT nAdjustment;                                 // specific adjustment of the Ruby-Ch.
  51
  52 public:
  53     SwFmtRuby( const String& rRubyTxt );
  54     SwFmtRuby( const SwFmtRuby& rAttr );
  55     virtual ~SwFmtRuby();
  56
  57     SwFmtRuby& operator=( const SwFmtRuby& rAttr );
  58
  59     // "pure virtual Methoden" vom SfxPoolItem
  60     virtual int             operator==( const SfxPoolItem& ) const;
  61     virtual SfxPoolItem*    Clone( SfxItemPool* pPool = 0 ) const;
  62     virtual SfxPoolItem*    Create(SvStream &, USHORT nVer) const;
  63     virtual SvStream&       Store(SvStream &, USHORT nIVer) const;
  64
  65
  66     virtual BOOL            QueryValue( ::com::sun::star::uno::Any& rVal,
  67                                     BYTE nMemberId = 0 ) const;
  68     virtual     BOOL                    PutValue( const ::com::sun::star::uno::Any& rVal,
  69                                         BYTE nMemberId = 0 );
  70
  71     virtual USHORT                      GetVersion( USHORT nFFVer ) const;
  72
  73     const SwTxtRuby* GetTxtRuby() const                 { return pTxtAttr; }
  74     SwTxtRuby* GetTxtRuby()                                             { return pTxtAttr; }
  75
  76     const String& GetText() const                               { return sRubyTxt; }
  77     void SetText( const String& rTxt )                  { sRubyTxt = rTxt; }
  78
  79     const String& GetCharFmtName() const                { return sCharFmtName; }
  80     void SetCharFmtName( const String& rNm )    { sCharFmtName = rNm; }
  81
  82     USHORT GetCharFmtId() const                                 { return nCharFmtId; }
  83     void SetCharFmtId( USHORT nNew )                    { nCharFmtId = nNew; }
  84
  85     USHORT GetPosition() const                                  { return nPosition; }
  86     void SetPosition( USHORT nNew )                             { nPosition = nNew; }
  87
  88     USHORT GetAdjustment() const                                { return nAdjustment; }
  89     void SetAdjustment( USHORT nNew )                   { nAdjustment = nNew; }
  90 };
  91
  92
  93 } //namespace binfilter
  94 #endif
  95