sc/inc/compare.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
  20 #pragma once
  21
  22 #include "queryentry.hxx"
  23
  24 #include <unotools/textsearch.hxx>
  25 #include <svl/sharedstring.hxx>
  26
  27 class ScDocument;
  28
  29 namespace sc {
  30
  31 struct Compare
  32 {
  33     struct Cell
  34     {
  35         double mfValue;
  36         svl::SharedString maStr;
  37         bool mbValue;
  38         bool mbEmpty;
  39
  40         Cell();
  41     };
  42
  43     Cell maCells[2];
  44
  45     ScQueryOp meOp;
  46     bool mbIgnoreCase;
  47
  48     Compare();
  49 };
  50
  51 struct CompareOptions
  52 {
  53     ScQueryEntry                    aQueryEntry;
  54     utl::SearchParam::SearchType    eSearchType;
  55     bool                            bMatchWholeCell;
  56
  57     CompareOptions( const ScDocument& rDoc, const ScQueryEntry& rEntry, utl::SearchParam::SearchType eSrchTyp );
  58 private:
  59     CompareOptions( const CompareOptions & ) = delete;
  60     CompareOptions& operator=( const CompareOptions & ) = delete;
  61 };
  62
  63 /** @param pOptions
  64         Used for comparing two strings, if given.
  65         NULL means that for comparing two strings ScQueryOp rComp.meOp is
  66         tested for SC_EQUAL and SC_NOT_EQUAL, else pOptions->aQueryEntry.eOp
  67         Case sensitivity document option is always to be passed in
  68         rComp.mbIgnoreCase.
  69  */
  70 double CompareFunc( const Compare& rComp, CompareOptions* pOptions = nullptr );
  71 double CompareFunc( const Compare::Cell& rCell1, double fCell2, const CompareOptions* pOptions );
  72 double CompareFunc( double fCell1, double fCell2 );
  73
  74 /**
  75  * Left cell is empty while the right cell is numeric.
  76  */
  77 double CompareEmptyToNumericFunc( double fCell2 );
  78
  79 }
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */