sc/inc/queryentry.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 #ifndef __SC_QUERYENTRY_HXX__
  21 #define __SC_QUERYENTRY_HXX__
  22
  23 #include "address.hxx"
  24 #include "global.hxx"
  25
  26 #include <vector>
  27
  28 namespace utl {
  29     class SearchParam;
  30     class TextSearch;
  31 }
  32
  33 /**
  34  * Each instance of this struct represents a single filtering criteria.
  35  */
  36 struct SC_DLLPUBLIC ScQueryEntry
  37 {
  38     enum QueryType { ByValue, ByString, ByDate, ByEmpty };
  39
  40     struct Item
  41     {
  42         QueryType     meType;
  43         double        mfVal;
  44         OUString maString;
  45
  46         Item() : meType(ByValue), mfVal(0.0) {}
  47
  48         bool operator== (const Item& r) const;
  49     };
  50     typedef std::vector<Item> QueryItemsType;
  51
  52     bool            bDoQuery;
  53     SCCOLROW        nField;
  54     ScQueryOp       eOp;
  55     ScQueryConnect  eConnect;
  56     mutable utl::SearchParam* pSearchParam;       // if RegExp, not saved
  57     mutable utl::TextSearch*  pSearchText;        // if RegExp, not saved
  58
  59     ScQueryEntry();
  60     ScQueryEntry(const ScQueryEntry& r);
  61     ~ScQueryEntry();
  62
  63     // creates pSearchParam and pSearchText if necessary, always RegExp!
  64     utl::TextSearch* GetSearchTextPtr( bool bCaseSens ) const;
  65
  66     QueryItemsType& GetQueryItems();
  67     const QueryItemsType& GetQueryItems() const;
  68     void SetQueryByEmpty();
  69     bool IsQueryByEmpty() const;
  70     void SetQueryByNonEmpty();
  71     bool IsQueryByNonEmpty() const;
  72     const Item& GetQueryItem() const;
  73     Item& GetQueryItem();
  74     void            Clear();
  75     ScQueryEntry&   operator=( const ScQueryEntry& r );
  76     bool            operator==( const ScQueryEntry& r ) const;
  77
  78 private:
  79     /**
  80      * Stores all query items.  It must contain at least one item at all times
  81      * (for single equality match queries or comparative queries).  It may
  82      * contain multiple items for multi-equality match queries.
  83      */
  84     mutable QueryItemsType maQueryItems;
  85 };
  86
  87 #endif
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */