include/svl/srchitem.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_SVL_SRCHITEM_HXX
  20 #define INCLUDED_SVL_SRCHITEM_HXX
  21
  22 #include <sal/config.h>
  23 #include <svl/svldllapi.h>
  24 #include <com/sun/star/util/SearchAlgorithms2.hpp>
  25 #include <com/sun/star/util/SearchFlags.hpp>
  26 #include <i18nutil/transliteration.hxx>
  27 #include <i18nutil/searchopt.hxx>
  28 #include <unotools/configitem.hxx>
  29 #include <svl/style.hxx>
  30 #include <svl/poolitem.hxx>
  31
  32 // defines ---------------------------------------------------------------
  33
  34 // commands
  35 enum class SvxSearchCmd
  36 {
  37     FIND          = 0,
  38     FIND_ALL      = 1,
  39     REPLACE       = 2,
  40     REPLACE_ALL   = 3,
  41 };
  42
  43 // search flags
  44 enum class SvxSearchCellType
  45 {
  46     FORMULA        = 0,
  47     VALUE          = 1,
  48     NOTE           = 2,
  49 };
  50
  51 enum class SvxSearchApp
  52 {
  53     WRITER        = 0,
  54     CALC          = 1,
  55     DRAW          = 2,
  56 };
  57
  58 // class SvxSearchItem ---------------------------------------------------
  59
  60 class SVL_DLLPUBLIC SvxSearchItem final :
  61         public SfxPoolItem,
  62         public utl::ConfigItem
  63 {
  64     i18nutil::SearchOptions2 m_aSearchOpt;
  65
  66     SfxStyleFamily  m_eFamily;            // style family
  67
  68     SvxSearchCmd    m_nCommand;           // command (Search, Search all, Replace, Replace all)
  69
  70     // Calc-specific
  71     SvxSearchCellType m_nCellType;          // Search in Formulas/Values/Notes
  72     SvxSearchApp    m_nAppFlag;           // application which the dialog is for
  73     bool            m_bRowDirection;      // search direction: row-wise/column-wise
  74     bool            m_bAllTables;         // search in all sheets
  75     bool            m_bSearchFiltered;      // search filtered cells.
  76     bool            m_bSearchFormatted;     // search formatted display strings
  77
  78     // Writer-specific
  79     bool            m_bNotes;
  80
  81     bool            m_bBackward;          // search backwards
  82     bool            m_bPattern;           // search for styles
  83     bool            m_bContent;           // search in content
  84     bool            m_bAsianOptions;      // use asian options?
  85
  86     // Start search at this point (absolute twips).
  87     sal_Int32       m_nStartPointX;
  88     sal_Int32       m_nStartPointY;
  89
  90     virtual void    ImplCommit() override;
  91
  92 public:
  93     static SfxPoolItem* CreateDefault();
  94
  95     explicit SvxSearchItem( const sal_uInt16 nId );
  96     SvxSearchItem( const SvxSearchItem& rItem );
  97     virtual ~SvxSearchItem() override;
  98
  99     virtual bool             QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
 100     virtual bool             PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
 101     virtual bool             operator == ( const SfxPoolItem& ) const override;
 102     virtual SvxSearchItem*  Clone( SfxItemPool *pPool = nullptr ) const override;
 103     virtual bool GetPresentation( SfxItemPresentation ePres,
 104                                   MapUnit eCoreMetric,
 105                                   MapUnit ePresMetric,
 106                                   OUString &rText, const IntlWrapper& ) const override;
 107
 108     // ConfigItem
 109     virtual void            Notify( const css::uno::Sequence< OUString > &rPropertyNames ) override;
 110
 111     bool equalsIgnoring(const SvxSearchItem& rSItem, bool bIgnoreReplace,
 112                         bool bIgnoreCommand) const;
 113
 114             SvxSearchCmd    GetCommand() const { return m_nCommand; }
 115             void            SetCommand(SvxSearchCmd nNewCommand) { m_nCommand = nNewCommand; }
 116
 117     inline  const OUString& GetSearchString() const;
 118     inline  void            SetSearchString(const OUString& rNewString);
 119
 120     inline  const OUString& GetReplaceString() const;
 121     inline  void            SetReplaceString(const OUString& rNewString);
 122
 123     inline  bool            GetWordOnly() const;
 124             void            SetWordOnly(bool bNewWordOnly);
 125
 126     inline  bool            GetExact() const;
 127             void            SetExact(bool bNewExact);
 128
 129             bool            GetBackward() const { return m_bBackward; }
 130             void            SetBackward(bool bNewBackward) { m_bBackward = bNewBackward; }
 131
 132     inline  bool            GetSelection() const;
 133             void            SetSelection(bool bNewSelection);
 134
 135     inline  bool            GetRegExp() const;
 136             void            SetRegExp( bool bVal );
 137
 138     inline  bool            GetWildcard() const;
 139             void            SetWildcard( bool bVal );
 140
 141             bool            GetPattern() const { return m_bPattern; }
 142             void            SetPattern(bool bNewPattern) { m_bPattern = bNewPattern; }
 143
 144             SfxStyleFamily  GetFamily() const { return m_eFamily; }
 145             void            SetFamily( SfxStyleFamily eNewFamily )
 146                                 { m_eFamily = eNewFamily; }
 147
 148             bool            GetRowDirection() const { return m_bRowDirection; }
 149             void            SetRowDirection(bool bNewRowDirection) { m_bRowDirection = bNewRowDirection; }
 150
 151             bool            IsAllTables() const { return m_bAllTables; }
 152             void            SetAllTables(bool bNew) { m_bAllTables = bNew; }
 153
 154             bool            IsSearchFiltered() const { return m_bSearchFiltered; }
 155             void            SetSearchFiltered(bool b) { m_bSearchFiltered = b; }
 156
 157             bool            IsSearchFormatted() const { return m_bSearchFormatted; }
 158             void            SetSearchFormatted(bool b) { m_bSearchFormatted = b; }
 159
 160             SvxSearchCellType GetCellType() const { return m_nCellType; }
 161             void            SetCellType(SvxSearchCellType nNewCellType) { m_nCellType = nNewCellType; }
 162
 163             bool            GetNotes() const { return m_bNotes; }
 164             void            SetNotes(bool bNew) { m_bNotes = bNew; }
 165
 166             SvxSearchApp    GetAppFlag() const { return m_nAppFlag; }
 167             void            SetAppFlag(SvxSearchApp nNewAppFlag) { m_nAppFlag = nNewAppFlag; }
 168
 169     inline  bool            IsLevenshtein() const;
 170             void            SetLevenshtein( bool bVal );
 171
 172     inline  bool            IsLEVRelaxed() const;
 173             void            SetLEVRelaxed(bool bSet);
 174
 175     inline  sal_uInt16      GetLEVOther() const;
 176     inline  void            SetLEVOther(sal_uInt16 nSet);
 177
 178     inline  sal_uInt16      GetLEVShorter() const;
 179     inline  void            SetLEVShorter(sal_uInt16 nSet);
 180
 181     inline  sal_uInt16      GetLEVLonger() const;
 182     inline  void            SetLEVLonger(sal_uInt16 nSet);
 183
 184     inline const i18nutil::SearchOptions2 &
 185                             GetSearchOptions() const;
 186     inline void             SetSearchOptions( const i18nutil::SearchOptions2 &rOpt );
 187
 188     inline  TransliterationFlags
 189                             GetTransliterationFlags() const;
 190             void            SetTransliterationFlags( TransliterationFlags nFlags );
 191
 192     inline  bool            IsMatchFullHalfWidthForms() const;
 193     void                    SetMatchFullHalfWidthForms( bool bVal );
 194
 195     bool            IsUseAsianOptions() const           { return m_bAsianOptions; }
 196     void            SetUseAsianOptions( bool bVal ) { m_bAsianOptions = bVal; }
 197
 198     sal_Int32 GetStartPointX() const;
 199     sal_Int32 GetStartPointY() const;
 200     /// Either x or y start point is set.
 201     bool HasStartPoint() const;
 202 };
 203
 204 const OUString& SvxSearchItem::GetSearchString() const
 205 {
 206     return m_aSearchOpt.searchString;
 207 }
 208
 209 void SvxSearchItem::SetSearchString(const OUString& rNewString)
 210 {
 211     m_aSearchOpt.searchString = rNewString;
 212 }
 213
 214 const OUString& SvxSearchItem::GetReplaceString() const
 215 {
 216     return m_aSearchOpt.replaceString;
 217 }
 218
 219 void SvxSearchItem::SetReplaceString(const OUString& rNewString)
 220 {
 221     m_aSearchOpt.replaceString = rNewString;
 222 }
 223
 224 bool SvxSearchItem::GetWordOnly() const
 225 {
 226     return 0 != (m_aSearchOpt.searchFlag &
 227                         css::util::SearchFlags::NORM_WORD_ONLY);
 228 }
 229
 230 bool SvxSearchItem::GetExact() const
 231 {
 232     return !(m_aSearchOpt.transliterateFlags & TransliterationFlags::IGNORE_CASE);
 233 }
 234
 235 bool SvxSearchItem::GetSelection() const
 236 {
 237     return 0 != (m_aSearchOpt.searchFlag & css::util::SearchFlags::REG_NOT_BEGINOFLINE);
 238 }
 239
 240 bool SvxSearchItem::GetRegExp() const
 241 {
 242     // Ensure old and new algorithm types are in sync until all places are
 243     // adapted to use only new types.
 244     assert( (m_aSearchOpt.algorithmType == css::util::SearchAlgorithms_REGEXP) ==
 245             (m_aSearchOpt.AlgorithmType2 == css::util::SearchAlgorithms2::REGEXP));
 246     return m_aSearchOpt.AlgorithmType2 == css::util::SearchAlgorithms2::REGEXP ;
 247 }
 248
 249 bool SvxSearchItem::GetWildcard() const
 250 {
 251     // Ensure old and new algorithm types are in sync, in this case old is not
 252     // REGEXP or APPROXIMATE.
 253     assert( m_aSearchOpt.AlgorithmType2 != css::util::SearchAlgorithms2::WILDCARD ||
 254             (m_aSearchOpt.algorithmType != css::util::SearchAlgorithms_REGEXP &&
 255              m_aSearchOpt.algorithmType != css::util::SearchAlgorithms_APPROXIMATE) );
 256     return m_aSearchOpt.AlgorithmType2 == css::util::SearchAlgorithms2::WILDCARD ;
 257 }
 258
 259 bool SvxSearchItem::IsLEVRelaxed() const
 260 {
 261     return 0 != (m_aSearchOpt.searchFlag & css::util::SearchFlags::LEV_RELAXED);
 262 }
 263
 264 sal_uInt16 SvxSearchItem::GetLEVOther() const
 265 {
 266     return static_cast<sal_Int16>(m_aSearchOpt.changedChars);
 267 }
 268
 269 void SvxSearchItem::SetLEVOther( sal_uInt16 nVal )
 270 {
 271     m_aSearchOpt.changedChars = nVal;
 272 }
 273
 274 sal_uInt16 SvxSearchItem::GetLEVShorter() const
 275 {
 276     return static_cast<sal_Int16>(m_aSearchOpt.insertedChars);
 277 }
 278
 279 void SvxSearchItem::SetLEVShorter( sal_uInt16 nVal )
 280 {
 281     m_aSearchOpt.insertedChars = nVal;
 282 }
 283
 284 sal_uInt16 SvxSearchItem::GetLEVLonger() const
 285 {
 286     return static_cast<sal_Int16>(m_aSearchOpt.deletedChars);
 287 }
 288
 289 void SvxSearchItem::SetLEVLonger( sal_uInt16 nVal )
 290 {
 291     m_aSearchOpt.deletedChars = nVal;
 292 }
 293
 294 bool SvxSearchItem::IsLevenshtein() const
 295 {
 296     // Ensure old and new algorithm types are in sync until all places are
 297     // adapted to use only new types.
 298     assert( (m_aSearchOpt.algorithmType == css::util::SearchAlgorithms_APPROXIMATE) ==
 299             (m_aSearchOpt.AlgorithmType2 == css::util::SearchAlgorithms2::APPROXIMATE));
 300     return m_aSearchOpt.AlgorithmType2 == css::util::SearchAlgorithms2::APPROXIMATE;
 301 }
 302
 303 const i18nutil::SearchOptions2 & SvxSearchItem::GetSearchOptions() const
 304 {
 305     return m_aSearchOpt;
 306 }
 307
 308 void SvxSearchItem::SetSearchOptions( const i18nutil::SearchOptions2 &rOpt )
 309 {
 310     m_aSearchOpt = rOpt;
 311 }
 312
 313 TransliterationFlags SvxSearchItem::GetTransliterationFlags() const
 314 {
 315     return m_aSearchOpt.transliterateFlags;
 316 }
 317
 318 bool SvxSearchItem::IsMatchFullHalfWidthForms() const
 319 {
 320     return bool(m_aSearchOpt.transliterateFlags & TransliterationFlags::IGNORE_WIDTH);
 321 }
 322
 323 #endif
 324
 325
 326 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */