svx/inc/hlnkitem.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: hlnkitem.hxx,v $
  10  * $Revision: 1.6.216.1 $
  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_HLNKITEM_HXX
  31 #define _SVX_HLNKITEM_HXX
  32
  33 #include <tools/string.hxx>
  34 #include <svtools/poolitem.hxx>
  35 #include <sfx2/sfxsids.hrc>
  36 #include <svtools/macitem.hxx>
  37 #include "svx/svxdllapi.h"
  38
  39 #define HYPERDLG_EVENT_MOUSEOVER_OBJECT         0x0001
  40 #define HYPERDLG_EVENT_MOUSECLICK_OBJECT        0x0002
  41 #define HYPERDLG_EVENT_MOUSEOUT_OBJECT          0x0004
  42
  43 enum SvxLinkInsertMode
  44 {
  45     HLINK_DEFAULT,
  46     HLINK_FIELD,
  47     HLINK_BUTTON,
  48     HLINK_HTMLMODE = 0x0080
  49 };
  50
  51 class SVX_DLLPUBLIC SvxHyperlinkItem : public SfxPoolItem
  52 {
  53     String sName;
  54     String sURL;
  55     String sTarget;
  56     SvxLinkInsertMode eType;
  57
  58     String sIntName;
  59     SvxMacroTableDtor*  pMacroTable;
  60
  61     USHORT nMacroEvents;
  62
  63 public:
  64     TYPEINFO();
  65
  66     SvxHyperlinkItem( USHORT _nWhich = SID_HYPERLINK_GETLINK ):
  67                 SfxPoolItem(_nWhich), pMacroTable(NULL) { eType = HLINK_DEFAULT; nMacroEvents=0; };
  68     SvxHyperlinkItem( const SvxHyperlinkItem& rHyperlinkItem );
  69     SvxHyperlinkItem( USHORT nWhich, String& rName, String& rURL,
  70                                     String& rTarget, String& rIntName,
  71                                     SvxLinkInsertMode eTyp = HLINK_FIELD,
  72                                     USHORT nEvents = 0,
  73                                     SvxMacroTableDtor *pMacroTbl =NULL );
  74     virtual     ~SvxHyperlinkItem () { delete pMacroTable; }
  75
  76     inline SvxHyperlinkItem& operator=( const SvxHyperlinkItem &rItem );
  77
  78     virtual int                          operator==( const SfxPoolItem& ) const;
  79     virtual SfxPoolItem*         Clone( SfxItemPool *pPool = 0 ) const;
  80     virtual     BOOL             QueryValue( com::sun::star::uno::Any& rVal, BYTE nMemberId = 0 ) const;
  81     virtual     BOOL                     PutValue( const com::sun::star::uno::Any& rVal, BYTE nMemberId = 0 );
  82
  83     const       String& GetName() const { return sName; }
  84     void        SetName(const String& rName) { sName = rName; }
  85
  86     const       String& GetURL() const { return sURL; }
  87     void        SetURL(const String& rURL) { sURL = rURL; }
  88
  89     const       String& GetIntName () const { return sIntName; }
  90     void        SetIntName(const String& rIntName) { sIntName = rIntName; }
  91
  92     const       String& GetTargetFrame() const { return sTarget; }
  93     void        SetTargetFrame(const String& rTarget) { sTarget = rTarget; }
  94
  95     SvxLinkInsertMode GetInsertMode() const { return eType; }
  96     void        SetInsertMode( SvxLinkInsertMode eNew ) { eType = eNew; }
  97
  98     void SetMacro( USHORT nEvent, const SvxMacro& rMacro );
  99
 100     void SetMacroTable( const SvxMacroTableDtor& rTbl );
 101     const SvxMacroTableDtor* GetMacroTbl() const        { return pMacroTable; }
 102
 103     void SetMacroEvents (const USHORT nEvents) { nMacroEvents = nEvents; }
 104     USHORT GetMacroEvents() const { return nMacroEvents; }
 105
 106     virtual SvStream&                   Store( SvStream &, USHORT nItemVersion ) const;
 107     virtual SfxPoolItem*                Create( SvStream &, USHORT nVer ) const;
 108
 109 };
 110
 111 #endif
 112
 113