sw/source/ui/misc/pgfnote.cxx

   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
  20 #include <cmdid.h>
  21 #include <fmtfsize.hxx>
  22 #include <hintids.hxx>
  23 #include <svtools/unitconv.hxx>
  24 #include <vcl/fieldvalues.hxx>
  25 #include <unotools/localedatawrapper.hxx>
  26 #include <unotools/syslocale.hxx>
  27 #include <editeng/borderline.hxx>
  28 #include <editeng/sizeitem.hxx>
  29 #include <svx/pageitem.hxx>
  30 #include <svl/eitem.hxx>
  31 #include <editeng/ulspitem.hxx>
  32 #include <svl/grabbagitem.hxx>
  33 #include <uitool.hxx>
  34 #include <pagedesc.hxx>
  35 #include <pgfnote.hxx>
  36 #include <uiitems.hxx>
  37
  38 #include <memory>
  39
  40 using namespace ::com::sun::star;
  41
  42 const WhichRangesContainer SwFootNotePage::s_aPageRg(svl::Items<FN_PARAM_FTN_INFO, FN_PARAM_FTN_INFO>);
  43
  44 // handler to switch between the different possibilities how the footnote
  45 // region's height can be set.
  46 IMPL_LINK_NOARG(SwFootNotePage, HeightPage, weld::Toggleable&, void)
  47 {
  48     if (m_xMaxHeightPageBtn->get_active())
  49         m_xMaxHeightEdit->set_sensitive(false);
  50 }
  51
  52 IMPL_LINK_NOARG(SwFootNotePage, HeightMetric, weld::Toggleable&, void)
  53 {
  54     if (m_xMaxHeightBtn->get_active())
  55     {
  56         m_xMaxHeightEdit->set_sensitive(true);
  57         m_xMaxHeightEdit->grab_focus();
  58     }
  59 }
  60
  61 // handler limit values
  62 IMPL_LINK_NOARG(SwFootNotePage, HeightModify, weld::MetricSpinButton&, void)
  63 {
  64     m_xMaxHeightEdit->set_max(m_xMaxHeightEdit->normalize(m_lMaxHeight -
  65             (m_xDistEdit->denormalize(m_xDistEdit->get_value(FieldUnit::TWIP)) +
  66             m_xLineDistEdit->denormalize(m_xLineDistEdit->get_value(FieldUnit::TWIP)))),
  67             FieldUnit::TWIP);
  68     if (m_xMaxHeightEdit->get_value(FieldUnit::NONE) < 0)
  69         m_xMaxHeightEdit->set_value(0, FieldUnit::NONE);
  70     m_xDistEdit->set_max(m_xDistEdit->normalize(m_lMaxHeight -
  71             (m_xMaxHeightEdit->denormalize(m_xMaxHeightEdit->get_value(FieldUnit::TWIP)) +
  72             m_xLineDistEdit->denormalize(m_xLineDistEdit->get_value(FieldUnit::TWIP)))),
  73             FieldUnit::TWIP);
  74     if (m_xDistEdit->get_value(FieldUnit::NONE) < 0)
  75         m_xDistEdit->set_value(0, FieldUnit::NONE);
  76     m_xLineDistEdit->set_max(m_xLineDistEdit->normalize(m_lMaxHeight -
  77             (m_xMaxHeightEdit->denormalize(m_xMaxHeightEdit->get_value(FieldUnit::TWIP)) +
  78             m_xDistEdit->denormalize(m_xDistEdit->get_value(FieldUnit::TWIP)))),
  79             FieldUnit::TWIP);
  80 }
  81
  82 IMPL_LINK_NOARG(SwFootNotePage, LineWidthChanged_Impl, weld::MetricSpinButton&, void)
  83 {
  84     sal_Int64 nVal = m_xLineWidthEdit->get_value(FieldUnit::NONE);
  85     nVal = static_cast<sal_Int64>(vcl::ConvertDoubleValue(
  86                 nVal,
  87                 m_xLineWidthEdit->get_digits(),
  88                 m_xLineWidthEdit->get_unit(), MapUnit::MapTwip ));
  89     m_xLineTypeBox->SetWidth(nVal);
  90 }
  91
  92 IMPL_LINK(SwFootNotePage, LineColorSelected_Impl, ColorListBox&, rColorBox, void)
  93 {
  94     m_xLineTypeBox->SetColor(rColorBox.GetSelectEntryColor());
  95 }
  96
  97 SwFootNotePage::SwFootNotePage(weld::Container* pPage, weld::DialogController* pController, const SfxItemSet &rSet)
  98     : SfxTabPage(pPage, pController, u"modules/swriter/ui/footnoteareapage.ui"_ustr, u"FootnoteAreaPage"_ustr, &rSet)
  99     , m_lMaxHeight(0)
 100     , m_xMaxHeightPageBtn(m_xBuilder->weld_radio_button(u"maxheightpage"_ustr))
 101     , m_xMaxHeightBtn(m_xBuilder->weld_radio_button(u"maxheight"_ustr))
 102     , m_xMaxHeightEdit(m_xBuilder->weld_metric_spin_button(u"maxheightsb"_ustr, FieldUnit::CM))
 103     , m_xDistLabel(m_xBuilder->weld_label(u"spacetotextlabel"_ustr))
 104     , m_xDistEdit(m_xBuilder->weld_metric_spin_button(u"spacetotext"_ustr, FieldUnit::CM))
 105     , m_xLinePosLabel(m_xBuilder->weld_label(u"positionlabel"_ustr))
 106     , m_xLinePosBox(m_xBuilder->weld_combo_box(u"position"_ustr))
 107     , m_xLineTypeBox(new SvtLineListBox(m_xBuilder->weld_menu_button(u"style"_ustr)))
 108     , m_xLineWidthEdit(m_xBuilder->weld_metric_spin_button(u"thickness"_ustr, FieldUnit::POINT))
 109     , m_xLineColorBox(new ColorListBox(m_xBuilder->weld_menu_button(u"color"_ustr),
 110                 [this]{ return GetDialogController()->getDialog(); }))
 111     , m_xLineLengthLabel(m_xBuilder->weld_label(u"lengthlabel"_ustr))
 112     , m_xLineLengthEdit(m_xBuilder->weld_metric_spin_button(u"length"_ustr, FieldUnit::PERCENT))
 113     , m_xLineDistLabel(m_xBuilder->weld_label(u"spacingtocontentslabel"_ustr))
 114     , m_xLineDistEdit(m_xBuilder->weld_metric_spin_button(u"spacingtocontents"_ustr, FieldUnit::CM))
 115 {
 116     SetExchangeSupport();
 117     FieldUnit aMetric = ::GetDfltMetric(false);
 118     ::SetFieldUnit(*m_xMaxHeightEdit, aMetric);
 119     ::SetFieldUnit(*m_xDistEdit, aMetric);
 120     ::SetFieldUnit(*m_xLineDistEdit, aMetric);
 121     MeasurementSystem eSys = SvtSysLocale().GetLocaleData().getMeasurementSystemEnum();
 122     tools::Long nHeightValue = MeasurementSystem::Metric != eSys ? 1440 : 1134;
 123     m_xMaxHeightEdit->set_value(m_xMaxHeightEdit->normalize(nHeightValue),FieldUnit::TWIP);
 124
 125     bool bContinuousEndnotes = false;
 126     if (const SfxGrabBagItem* pGragbagItem = rSet.GetItemIfSet(SID_ATTR_CHAR_GRABBAG))
 127     {
 128         auto it = pGragbagItem->GetGrabBag().find(u"ContinuousEndnotes"_ustr);
 129         if (it != pGragbagItem->GetGrabBag().end())
 130         {
 131             it->second >>= bContinuousEndnotes;
 132         }
 133     }
 134
 135     if (bContinuousEndnotes)
 136     {
 137         // These are ignored in SwFootnoteContFrame::Format() and SwFootnoteContFrame::PaintLine(),
 138         // hide them.
 139         m_xDistLabel->set_visible(false);
 140         m_xDistEdit->set_visible(false);
 141         m_xLinePosLabel->set_visible(false);
 142         m_xLinePosBox->set_visible(false);
 143         m_xLineLengthLabel->set_visible(false);
 144         m_xLineLengthEdit->set_visible(false);
 145         m_xLineDistLabel->set_visible(false);
 146         m_xLineDistEdit->set_visible(false);
 147     }
 148 }
 149
 150 SwFootNotePage::~SwFootNotePage()
 151 {
 152     m_xLineColorBox.reset();
 153     m_xLineTypeBox.reset();
 154 }
 155
 156 std::unique_ptr<SfxTabPage> SwFootNotePage::Create(weld::Container* pPage, weld::DialogController* pController, const SfxItemSet *rSet)
 157 {
 158     return std::make_unique<SwFootNotePage>(pPage, pController, *rSet);
 159 }
 160
 161 void SwFootNotePage::Reset(const SfxItemSet *rSet)
 162 {
 163     // if no example exists, otherwise Init here in Activate
 164     std::optional<SwPageFootnoteInfo> pDefFootnoteInfo;
 165     const SwPageFootnoteInfo* pFootnoteInfo;
 166     const SfxPoolItem* pItem = SfxTabPage::GetItem(*rSet, FN_PARAM_FTN_INFO);
 167     if( pItem )
 168     {
 169         pFootnoteInfo = &static_cast<const SwPageFootnoteInfoItem*>(pItem)->GetPageFootnoteInfo();
 170     }
 171     else
 172     {
 173         // when "standard" is being activated the footnote item is deleted,
 174         // that's why a footnote structure has to be created here
 175         pDefFootnoteInfo.emplace();
 176         pFootnoteInfo = &*pDefFootnoteInfo;
 177     }
 178         // footnote area's height
 179     SwTwips lHeight = pFootnoteInfo->GetHeight();
 180     if(lHeight)
 181     {
 182         m_xMaxHeightEdit->set_value(m_xMaxHeightEdit->normalize(lHeight),FieldUnit::TWIP);
 183         m_xMaxHeightBtn->set_active(true);
 184     }
 185     else
 186     {
 187         m_xMaxHeightPageBtn->set_active(true);
 188         m_xMaxHeightEdit->set_sensitive(false);
 189     }
 190     m_xMaxHeightPageBtn->connect_toggled(LINK(this,SwFootNotePage,HeightPage));
 191     m_xMaxHeightBtn->connect_toggled(LINK(this,SwFootNotePage,HeightMetric));
 192     Link<weld::MetricSpinButton&,void> aLk = LINK(this, SwFootNotePage, HeightModify);
 193     m_xMaxHeightEdit->connect_value_changed(aLk);
 194     m_xDistEdit->connect_value_changed(aLk);
 195     m_xLineDistEdit->connect_value_changed(aLk);
 196
 197     // Separator width
 198     m_xLineWidthEdit->connect_value_changed(LINK(this, SwFootNotePage, LineWidthChanged_Impl));
 199
 200     sal_Int64 nWidthPt = static_cast<sal_Int64>(vcl::ConvertDoubleValue(
 201             sal_Int64( pFootnoteInfo->GetLineWidth() ), m_xLineWidthEdit->get_digits(),
 202             MapUnit::MapTwip, m_xLineWidthEdit->get_unit( ) ));
 203     m_xLineWidthEdit->set_value(nWidthPt, FieldUnit::NONE);
 204
 205     // Separator style
 206     m_xLineTypeBox->SetSourceUnit( FieldUnit::TWIP );
 207
 208     m_xLineTypeBox->InsertEntry(
 209         ::editeng::SvxBorderLine::getWidthImpl(SvxBorderLineStyle::SOLID),
 210         SvxBorderLineStyle::SOLID );
 211     m_xLineTypeBox->InsertEntry(
 212         ::editeng::SvxBorderLine::getWidthImpl(SvxBorderLineStyle::DOTTED),
 213         SvxBorderLineStyle::DOTTED );
 214     m_xLineTypeBox->InsertEntry(
 215         ::editeng::SvxBorderLine::getWidthImpl(SvxBorderLineStyle::DASHED),
 216         SvxBorderLineStyle::DASHED );
 217     m_xLineTypeBox->SetWidth( pFootnoteInfo->GetLineWidth( ) );
 218     m_xLineTypeBox->SelectEntry( pFootnoteInfo->GetLineStyle() );
 219
 220     // Separator Color
 221     m_xLineColorBox->SelectEntry(pFootnoteInfo->GetLineColor());
 222     m_xLineColorBox->SetSelectHdl(LINK(this, SwFootNotePage, LineColorSelected_Impl));
 223     m_xLineTypeBox->SetColor(pFootnoteInfo->GetLineColor());
 224
 225     // position
 226     m_xLinePosBox->set_active(static_cast<sal_Int32>(pFootnoteInfo->GetAdj()));
 227
 228     // width
 229     Fraction aTmp( 100, 1 );
 230     aTmp *= pFootnoteInfo->GetWidth();
 231     m_xLineLengthEdit->set_value(static_cast<tools::Long>(aTmp), FieldUnit::PERCENT);
 232
 233     // gap footnote area
 234     m_xDistEdit->set_value(m_xDistEdit->normalize(pFootnoteInfo->GetTopDist()), FieldUnit::TWIP);
 235     m_xLineDistEdit->set_value(
 236         m_xLineDistEdit->normalize(pFootnoteInfo->GetBottomDist()), FieldUnit::TWIP);
 237     ActivatePage( *rSet );
 238 }
 239
 240 // stuff attributes into the set, when OK
 241 bool SwFootNotePage::FillItemSet(SfxItemSet *rSet)
 242 {
 243     SwPageFootnoteInfoItem aItem(GetItemSet().Get(FN_PARAM_FTN_INFO));
 244
 245     // that's the original
 246     SwPageFootnoteInfo &rFootnoteInfo = aItem.GetPageFootnoteInfo();
 247
 248     // footnote area's height
 249     if (m_xMaxHeightBtn->get_active())
 250         rFootnoteInfo.SetHeight( static_cast< SwTwips >(
 251                 m_xMaxHeightEdit->denormalize(m_xMaxHeightEdit->get_value(FieldUnit::TWIP))));
 252     else
 253         rFootnoteInfo.SetHeight(0);
 254
 255         // gap footnote area
 256     rFootnoteInfo.SetTopDist(  static_cast< SwTwips >(
 257             m_xDistEdit->denormalize(m_xDistEdit->get_value(FieldUnit::TWIP))));
 258     rFootnoteInfo.SetBottomDist(  static_cast< SwTwips >(
 259             m_xLineDistEdit->denormalize(m_xLineDistEdit->get_value(FieldUnit::TWIP))));
 260
 261     // Separator style
 262     rFootnoteInfo.SetLineStyle(m_xLineTypeBox->GetSelectEntryStyle());
 263
 264     // Separator width
 265     sal_Int64 nWidth = m_xLineWidthEdit->get_value(FieldUnit::NONE);
 266     nWidth = static_cast<tools::Long>(vcl::ConvertDoubleValue(
 267                    nWidth,
 268                    m_xLineWidthEdit->get_digits(),
 269                    m_xLineWidthEdit->get_unit(), MapUnit::MapTwip ));
 270     rFootnoteInfo.SetLineWidth( nWidth );
 271
 272     // Separator color
 273     rFootnoteInfo.SetLineColor(m_xLineColorBox->GetSelectEntryColor());
 274
 275     // Position
 276     rFootnoteInfo.SetAdj(static_cast<css::text::HorizontalAdjust>(m_xLinePosBox->get_active()));
 277
 278     // Width
 279     rFootnoteInfo.SetWidth(Fraction(m_xLineLengthEdit->get_value(FieldUnit::PERCENT), 100));
 280
 281     const SfxPoolItem* pOldItem;
 282     if(nullptr == (pOldItem = GetOldItem( *rSet, FN_PARAM_FTN_INFO )) ||
 283                 aItem != *pOldItem )
 284         rSet->Put(aItem);
 285
 286     return true;
 287 }
 288
 289 void SwFootNotePage::ActivatePage(const SfxItemSet& rSet)
 290 {
 291     auto const & rSize = rSet.Get( RES_FRM_SIZE );
 292     m_lMaxHeight = rSize.GetHeight();
 293
 294     if( const SvxSetItem* pHeaderSetItem = rSet.GetItemIfSet( rSet.GetPool()->GetWhichIDFromSlotID( SID_ATTR_PAGE_HEADERSET), false ) )
 295     {
 296         const SfxItemSet& rHeaderSet = pHeaderSetItem->GetItemSet();
 297         const SfxBoolItem& rHeaderOn =
 298             rHeaderSet.Get( rSet.GetPool()->GetWhichIDFromSlotID( SID_ATTR_PAGE_ON ) );
 299
 300         if ( rHeaderOn.GetValue() )
 301         {
 302             const SvxSizeItem& rSizeItem =
 303                 rHeaderSet.Get(rSet.GetPool()->GetWhichIDFromSlotID(SID_ATTR_PAGE_SIZE));
 304             m_lMaxHeight -= rSizeItem.GetSize().Height();
 305         }
 306     }
 307
 308     if( const SvxSetItem* pFooterSetItem = rSet.GetItemIfSet( rSet.GetPool()->GetWhichIDFromSlotID( SID_ATTR_PAGE_FOOTERSET),
 309             false ) )
 310     {
 311         const SfxItemSet& rFooterSet = pFooterSetItem->GetItemSet();
 312         const SfxBoolItem& rFooterOn = rFooterSet.Get( SID_ATTR_PAGE_ON );
 313
 314         if ( rFooterOn.GetValue() )
 315         {
 316             const SvxSizeItem& rSizeItem =
 317                 rFooterSet.Get( rSet.GetPool()->GetWhichIDFromSlotID( SID_ATTR_PAGE_SIZE ) );
 318             m_lMaxHeight -= rSizeItem.GetSize().Height();
 319         }
 320     }
 321
 322     if ( const SvxULSpaceItem* pSpaceItem = rSet.GetItemIfSet( RES_UL_SPACE , false ) )
 323     {
 324         m_lMaxHeight -= pSpaceItem->GetUpper() + pSpaceItem->GetLower();
 325     }
 326
 327     m_lMaxHeight *= 8;
 328     m_lMaxHeight /= 10;
 329
 330     // set maximum values
 331     HeightModify(*m_xMaxHeightEdit);
 332 }
 333
 334 DeactivateRC SwFootNotePage::DeactivatePage( SfxItemSet* _pSet)
 335 {
 336     if(_pSet)
 337         FillItemSet(_pSet);
 338
 339     return DeactivateRC::LeavePage;
 340 }
 341
 342 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */