sc/source/core/tool/docoptio.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 <svl/numformat.hxx>
  21 #include <osl/diagnose.h>
  22
  23 #include <com/sun/star/uno/Any.hxx>
  24 #include <com/sun/star/uno/Sequence.hxx>
  25
  26 #include <docoptio.hxx>
  27 #include <miscuno.hxx>
  28 #include <global.hxx>
  29
  30 using namespace utl;
  31 using namespace com::sun::star::uno;
  32
  33
  34 using sc::TwipsToEvenHMM;
  35
  36 static sal_uInt16 lcl_GetDefaultTabDist()
  37 {
  38     if ( ScOptionsUtil::IsMetricSystem() )
  39         return 709;                 // 1,25 cm
  40     else
  41         return 720;                 // 1/2"
  42 }
  43
  44 //      ScDocOptions - document options
  45
  46 ScDocOptions::ScDocOptions()
  47 {
  48     ResetDocOptions();
  49 }
  50
  51 void ScDocOptions::ResetDocOptions()
  52 {
  53     bIsIgnoreCase       = false;
  54     bIsIter             = false;
  55     nIterCount          = 100;
  56     fIterEps            = 1.0E-3;
  57     nPrecStandardFormat = SvNumberFormatter::UNLIMITED_PRECISION;
  58     nDay                = 30;
  59     nMonth              = 12;
  60     nYear               = 1899;
  61     nYear2000           = SvNumberFormatter::GetYear2000Default();
  62     nTabDistance        = lcl_GetDefaultTabDist();
  63     bCalcAsShown        = false;
  64     bMatchWholeCell     = true;
  65     bLookUpColRowNames  = true;
  66     bFormulaRegexEnabled= false;
  67     bFormulaWildcardsEnabled= true;
  68     eFormulaSearchType  = utl::SearchParam::SearchType::Wildcard;
  69     bWriteCalcConfig    = true;
  70 }
  71
  72 void ScDocOptions::SetFormulaRegexEnabled( bool bVal )
  73 {
  74     if (bVal)
  75     {
  76         bFormulaRegexEnabled = true;
  77         bFormulaWildcardsEnabled = false;
  78         eFormulaSearchType = utl::SearchParam::SearchType::Regexp;
  79     }
  80     else if (!bFormulaRegexEnabled)
  81         ;   // nothing changes for setting false to false
  82     else
  83     {
  84         bFormulaRegexEnabled = false;
  85         eFormulaSearchType = utl::SearchParam::SearchType::Unknown;
  86     }
  87 }
  88
  89 void ScDocOptions::SetFormulaWildcardsEnabled( bool bVal )
  90 {
  91     if (bVal)
  92     {
  93         bFormulaRegexEnabled = false;
  94         bFormulaWildcardsEnabled = true;
  95         eFormulaSearchType = utl::SearchParam::SearchType::Wildcard;
  96     }
  97     else if (!bFormulaWildcardsEnabled)
  98         ;   // nothing changes for setting false to false
  99     else
 100     {
 101         bFormulaWildcardsEnabled = false;
 102         eFormulaSearchType = utl::SearchParam::SearchType::Unknown;
 103     }
 104 }
 105
 106 //      ScTpCalcItem - data for the CalcOptions TabPage
 107
 108 ScTpCalcItem::ScTpCalcItem( sal_uInt16 nWhichP, const ScDocOptions& rOpt )
 109     :   SfxPoolItem ( nWhichP, SfxItemType::ScTpCalcItemType ),
 110         theOptions  ( rOpt )
 111 {
 112 }
 113
 114 ScTpCalcItem::~ScTpCalcItem()
 115 {
 116 }
 117
 118 bool ScTpCalcItem::operator==( const SfxPoolItem& rItem ) const
 119 {
 120     assert(SfxPoolItem::operator==(rItem));
 121
 122     const ScTpCalcItem& rPItem = static_cast<const ScTpCalcItem&>(rItem);
 123
 124     return ( theOptions == rPItem.theOptions );
 125 }
 126
 127 ScTpCalcItem* ScTpCalcItem::Clone( SfxItemPool * ) const
 128 {
 129     return new ScTpCalcItem( *this );
 130 }
 131
 132 //  Config Item containing document options
 133
 134 constexpr OUStringLiteral CFGPATH_CALC = u"Office.Calc/Calculate";
 135
 136 #define SCCALCOPT_ITER_ITER         0
 137 #define SCCALCOPT_ITER_STEPS        1
 138 #define SCCALCOPT_ITER_MINCHG       2
 139 #define SCCALCOPT_DATE_DAY          3
 140 #define SCCALCOPT_DATE_MONTH        4
 141 #define SCCALCOPT_DATE_YEAR         5
 142 #define SCCALCOPT_DECIMALS          6
 143 #define SCCALCOPT_CASESENSITIVE     7
 144 #define SCCALCOPT_PRECISION         8
 145 #define SCCALCOPT_SEARCHCRIT        9
 146 #define SCCALCOPT_FINDLABEL         10
 147 #define SCCALCOPT_REGEX             11
 148 #define SCCALCOPT_WILDCARDS         12
 149
 150 constexpr OUStringLiteral CFGPATH_DOCLAYOUT = u"Office.Calc/Layout/Other";
 151
 152 #define SCDOCLAYOUTOPT_TABSTOP      0
 153
 154 Sequence<OUString> ScDocCfg::GetCalcPropertyNames()
 155 {
 156     return {u"IterativeReference/Iteration"_ustr,     // SCCALCOPT_ITER_ITER
 157             u"IterativeReference/Steps"_ustr,         // SCCALCOPT_ITER_STEPS
 158             u"IterativeReference/MinimumChange"_ustr, // SCCALCOPT_ITER_MINCHG
 159             u"Other/Date/DD"_ustr,                    // SCCALCOPT_DATE_DAY
 160             u"Other/Date/MM"_ustr,                    // SCCALCOPT_DATE_MONTH
 161             u"Other/Date/YY"_ustr,                    // SCCALCOPT_DATE_YEAR
 162             u"Other/DecimalPlaces"_ustr,              // SCCALCOPT_DECIMALS
 163             u"Other/CaseSensitive"_ustr,              // SCCALCOPT_CASESENSITIVE
 164             u"Other/Precision"_ustr,                  // SCCALCOPT_PRECISION
 165             u"Other/SearchCriteria"_ustr,             // SCCALCOPT_SEARCHCRIT
 166             u"Other/FindLabel"_ustr,                  // SCCALCOPT_FINDLABEL
 167             u"Other/RegularExpressions"_ustr,         // SCCALCOPT_REGEX
 168             u"Other/Wildcards"_ustr};                 // SCCALCOPT_WILDCARDS
 169 }
 170
 171 Sequence<OUString> ScDocCfg::GetLayoutPropertyNames()
 172 {
 173     if (ScOptionsUtil::IsMetricSystem())
 174         return {u"TabStop/Metric"_ustr};    // SCDOCLAYOUTOPT_TABSTOP
 175     else
 176         return {u"TabStop/NonMetric"_ustr}; // SCDOCLAYOUTOPT_TABSTOP
 177 }
 178
 179 ScDocCfg::ScDocCfg() :
 180     aCalcItem( CFGPATH_CALC ),
 181     aLayoutItem(CFGPATH_DOCLAYOUT)
 182 {
 183     sal_Int32 nIntVal = 0;
 184
 185     Sequence<OUString> aNames;
 186     Sequence<Any> aValues;
 187     const Any* pValues = nullptr;
 188
 189     sal_uInt16 nDateDay, nDateMonth;
 190     sal_Int16 nDateYear;
 191     GetDate( nDateDay, nDateMonth, nDateYear );
 192
 193     aNames = GetCalcPropertyNames();
 194     aValues = aCalcItem.GetProperties(aNames);
 195     aCalcItem.EnableNotification(aNames);
 196     pValues = aValues.getConstArray();
 197     OSL_ENSURE(aValues.getLength() == aNames.getLength(), "GetProperties failed");
 198     if(aValues.getLength() == aNames.getLength())
 199     {
 200         double fDoubleVal = 0;
 201         for(int nProp = 0; nProp < aNames.getLength(); nProp++)
 202         {
 203             OSL_ENSURE(pValues[nProp].hasValue(), "property value missing");
 204             if(pValues[nProp].hasValue())
 205             {
 206                 switch(nProp)
 207                 {
 208                     case SCCALCOPT_ITER_ITER:
 209                         SetIter( ScUnoHelpFunctions::GetBoolFromAny( pValues[nProp] ) );
 210                         break;
 211                     case SCCALCOPT_ITER_STEPS:
 212                         if (pValues[nProp] >>= nIntVal) SetIterCount( static_cast<sal_uInt16>(nIntVal) );
 213                         break;
 214                     case SCCALCOPT_ITER_MINCHG:
 215                         if (pValues[nProp] >>= fDoubleVal) SetIterEps( fDoubleVal );
 216                         break;
 217                     case SCCALCOPT_DATE_DAY:
 218                         if (pValues[nProp] >>= nIntVal) nDateDay = static_cast<sal_uInt16>(nIntVal);
 219                         break;
 220                     case SCCALCOPT_DATE_MONTH:
 221                         if (pValues[nProp] >>= nIntVal) nDateMonth = static_cast<sal_uInt16>(nIntVal);
 222                         break;
 223                     case SCCALCOPT_DATE_YEAR:
 224                         if (pValues[nProp] >>= nIntVal) nDateYear = static_cast<sal_Int16>(nIntVal);
 225                         break;
 226                     case SCCALCOPT_DECIMALS:
 227                         if (pValues[nProp] >>= nIntVal) SetStdPrecision( static_cast<sal_uInt16>(nIntVal) );
 228                         break;
 229                     case SCCALCOPT_CASESENSITIVE:
 230                         // content is reversed
 231                         SetIgnoreCase( !ScUnoHelpFunctions::GetBoolFromAny( pValues[nProp] ) );
 232                         break;
 233                     case SCCALCOPT_PRECISION:
 234                         SetCalcAsShown( ScUnoHelpFunctions::GetBoolFromAny( pValues[nProp] ) );
 235                         break;
 236                     case SCCALCOPT_SEARCHCRIT:
 237                         SetMatchWholeCell( ScUnoHelpFunctions::GetBoolFromAny( pValues[nProp] ) );
 238                         break;
 239                     case SCCALCOPT_FINDLABEL:
 240                         SetLookUpColRowNames( ScUnoHelpFunctions::GetBoolFromAny( pValues[nProp] ) );
 241                         break;
 242                     case SCCALCOPT_REGEX :
 243                         SetFormulaRegexEnabled( ScUnoHelpFunctions::GetBoolFromAny( pValues[nProp] ) );
 244                         break;
 245                     case SCCALCOPT_WILDCARDS :
 246                         SetFormulaWildcardsEnabled( ScUnoHelpFunctions::GetBoolFromAny( pValues[nProp] ) );
 247                         break;
 248                 }
 249             }
 250         }
 251     }
 252     aCalcItem.SetCommitLink( LINK( this, ScDocCfg, CalcCommitHdl ) );
 253
 254     SetDate( nDateDay, nDateMonth, nDateYear );
 255
 256     aNames = GetLayoutPropertyNames();
 257     aValues = aLayoutItem.GetProperties(aNames);
 258     aLayoutItem.EnableNotification(aNames);
 259     pValues = aValues.getConstArray();
 260     OSL_ENSURE(aValues.getLength() == aNames.getLength(), "GetProperties failed");
 261     if(aValues.getLength() == aNames.getLength())
 262     {
 263         for(int nProp = 0; nProp < aNames.getLength(); nProp++)
 264         {
 265             OSL_ENSURE(pValues[nProp].hasValue(), "property value missing");
 266             if(pValues[nProp].hasValue())
 267             {
 268                 switch(nProp)
 269                 {
 270                     case SCDOCLAYOUTOPT_TABSTOP:
 271                         // TabDistance in ScDocOptions is in twips
 272                         if (pValues[nProp] >>= nIntVal)
 273                             SetTabDistance(o3tl::toTwips(nIntVal, o3tl::Length::mm100));
 274                         break;
 275                 }
 276             }
 277         }
 278     }
 279     aLayoutItem.SetCommitLink( LINK( this, ScDocCfg, LayoutCommitHdl ) );
 280 }
 281
 282 IMPL_LINK_NOARG(ScDocCfg, CalcCommitHdl, ScLinkConfigItem&, void)
 283 {
 284     Sequence<OUString> aNames = GetCalcPropertyNames();
 285     Sequence<Any> aValues(aNames.getLength());
 286     Any* pValues = aValues.getArray();
 287
 288     sal_uInt16 nDateDay, nDateMonth;
 289     sal_Int16 nDateYear;
 290     GetDate( nDateDay, nDateMonth, nDateYear );
 291
 292     for(int nProp = 0; nProp < aNames.getLength(); nProp++)
 293     {
 294         switch(nProp)
 295         {
 296             case SCCALCOPT_ITER_ITER:
 297                 pValues[nProp] <<= IsIter();
 298                 break;
 299             case SCCALCOPT_ITER_STEPS:
 300                 pValues[nProp] <<= static_cast<sal_Int32>(GetIterCount());
 301                 break;
 302             case SCCALCOPT_ITER_MINCHG:
 303                 pValues[nProp] <<= GetIterEps();
 304                 break;
 305             case SCCALCOPT_DATE_DAY:
 306                 pValues[nProp] <<= static_cast<sal_Int32>(nDateDay);
 307                 break;
 308             case SCCALCOPT_DATE_MONTH:
 309                 pValues[nProp] <<= static_cast<sal_Int32>(nDateMonth);
 310                 break;
 311             case SCCALCOPT_DATE_YEAR:
 312                 pValues[nProp] <<= static_cast<sal_Int32>(nDateYear);
 313                 break;
 314             case SCCALCOPT_DECIMALS:
 315                 pValues[nProp] <<= static_cast<sal_Int32>(GetStdPrecision());
 316                 break;
 317             case SCCALCOPT_CASESENSITIVE:
 318                 // content is reversed
 319                 pValues[nProp] <<= !IsIgnoreCase();
 320                 break;
 321             case SCCALCOPT_PRECISION:
 322                 pValues[nProp] <<= IsCalcAsShown();
 323                 break;
 324             case SCCALCOPT_SEARCHCRIT:
 325                 pValues[nProp] <<= IsMatchWholeCell();
 326                 break;
 327             case SCCALCOPT_FINDLABEL:
 328                 pValues[nProp] <<= IsLookUpColRowNames();
 329                 break;
 330             case SCCALCOPT_REGEX :
 331                 pValues[nProp] <<= IsFormulaRegexEnabled();
 332                 break;
 333             case SCCALCOPT_WILDCARDS :
 334                 pValues[nProp] <<= IsFormulaWildcardsEnabled();
 335                 break;
 336         }
 337     }
 338     aCalcItem.PutProperties(aNames, aValues);
 339 }
 340
 341 IMPL_LINK_NOARG(ScDocCfg, LayoutCommitHdl, ScLinkConfigItem&, void)
 342 {
 343     Sequence<OUString> aNames = GetLayoutPropertyNames();
 344     Sequence<Any> aValues(aNames.getLength());
 345     Any* pValues = aValues.getArray();
 346
 347     for(int nProp = 0; nProp < aNames.getLength(); nProp++)
 348     {
 349         switch(nProp)
 350         {
 351             case SCDOCLAYOUTOPT_TABSTOP:
 352                 //  TabDistance in ScDocOptions is in twips
 353                 //  use only even numbers, so defaults don't get changed
 354                 //  by modifying other settings in the same config item
 355                 pValues[nProp] <<= static_cast<sal_Int32>(TwipsToEvenHMM( GetTabDistance() ));
 356                 break;
 357         }
 358     }
 359     aLayoutItem.PutProperties(aNames, aValues);
 360 }
 361
 362 void ScDocCfg::SetOptions( const ScDocOptions& rNew )
 363 {
 364     *static_cast<ScDocOptions*>(this) = rNew;
 365
 366     aCalcItem.SetModified();
 367     aLayoutItem.SetModified();
 368 }
 369
 370 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */