Line data    Source code

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