sw/inc/fmtinfmt.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_SW_INC_FMTINFMT_HXX
  20 #define INCLUDED_SW_INC_FMTINFMT_HXX
  21
  22 #include <svl/poolitem.hxx>
  23 #include "swdllapi.h"
  24 #include <memory>
  25
  26 class SvxMacro;
  27 class SvxMacroTableDtor;
  28 class SwTextINetFormat;
  29 class IntlWrapper;
  30
  31 // ATT_INETFMT
  32
  33 class SW_DLLPUBLIC SwFormatINetFormat: public SfxPoolItem
  34 {
  35     friend class SwTextINetFormat;
  36
  37     OUString msURL;                  ///< URL.
  38     OUString msTargetFrame;          ///< Target frame for URL.
  39     OUString msINetFormatName;
  40     OUString msVisitedFormatName;
  41     OUString msHyperlinkName;        ///< Name of the link.
  42     std::unique_ptr<SvxMacroTableDtor> mpMacroTable;
  43     SwTextINetFormat* mpTextAttr;         ///< My TextAttribute.
  44     sal_uInt16 mnINetFormatId;
  45     sal_uInt16 mnVisitedFormatId;
  46 public:
  47     SwFormatINetFormat( const OUString& rURL, const OUString& rTarget );
  48     SwFormatINetFormat( const SwFormatINetFormat& rAttr );
  49     SwFormatINetFormat();                     ///< For TypeInfo.
  50     virtual ~SwFormatINetFormat() override;
  51
  52     static SfxPoolItem* CreateDefault();
  53
  54     /// "Pure virtual methods" of SfxPoolItem.
  55     virtual bool            operator==( const SfxPoolItem& ) const override;
  56     virtual SfxPoolItem*    Clone( SfxItemPool* pPool = nullptr ) const override;
  57     virtual bool GetPresentation( SfxItemPresentation ePres,
  58                                   MapUnit eCoreMetric,
  59                                   MapUnit ePresMetric,
  60                                   OUString &rText,
  61                                   const IntlWrapper* pIntl = nullptr ) const override;
  62
  63     virtual bool QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  64     virtual bool PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  65
  66     const SwTextINetFormat* GetTextINetFormat() const
  67     {
  68         return mpTextAttr;
  69     }
  70
  71     const OUString& GetValue() const
  72     {
  73         return msURL;
  74     }
  75
  76     const OUString& GetName() const
  77     {
  78         return msHyperlinkName;
  79     }
  80     void SetName( const OUString& rNm )
  81     {
  82         msHyperlinkName = rNm;
  83     }
  84
  85     const OUString& GetTargetFrame() const
  86     {
  87         return msTargetFrame;
  88     }
  89
  90     void SetINetFormatAndId(
  91             const OUString& rNm,
  92             const sal_uInt16 nId )
  93     {
  94         msINetFormatName = rNm;
  95         mnINetFormatId = nId;
  96     }
  97
  98     const OUString& GetINetFormat() const
  99     {
 100         return msINetFormatName;
 101     }
 102
 103     sal_uInt16 GetINetFormatId() const
 104     {
 105         return mnINetFormatId;
 106     }
 107
 108     void SetVisitedFormatAndId(
 109             const OUString& rNm,
 110             const sal_uInt16 nId )
 111     {
 112         msVisitedFormatName = rNm;
 113         mnVisitedFormatId = nId;
 114     }
 115
 116     const OUString& GetVisitedFormat() const
 117     {
 118         return msVisitedFormatName;
 119     }
 120
 121     sal_uInt16 GetVisitedFormatId() const
 122     {
 123         return mnVisitedFormatId;
 124     }
 125
 126     /// Set a new MacroTable or clear the current one.
 127     void SetMacroTable( const SvxMacroTableDtor* pTable );
 128     const SvxMacroTableDtor* GetMacroTable() const
 129     {
 130         return mpMacroTable.get();
 131     }
 132
 133     /// Macro getter and setter.
 134     void SetMacro(
 135             sal_uInt16 nEvent,
 136             const SvxMacro& rMacro );
 137     const SvxMacro* GetMacro( sal_uInt16 nEvent ) const;
 138 };
 139
 140 #endif
 141
 142 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */