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 SW_ACMPLWRD_HXX
      21             : #define SW_ACMPLWRD_HXX
      22             : 
      23             : #include <deque>
      24             : 
      25             : #include <editeng/swafopt.hxx>
      26             : #include <editeng/LatinLookupTree.hxx>
      27             : 
      28             : class SwDoc;
      29             : class SwAutoCompleteWord_Impl;
      30             : class SwAutoCompleteClient;
      31             : class SwAutoCompleteString;
      32             : 
      33             : typedef std::deque<SwAutoCompleteString*> SwAutoCompleteStringPtrDeque;
      34             : 
      35             : class SwAutoCompleteWord
      36             : {
      37             :     friend class SwAutoCompleteClient;
      38             : 
      39             :     /// contains extended strings carrying source information
      40             :     editeng::SortedAutoCompleteStrings m_WordList;
      41             :     LookupTree* m_LookupTree;
      42             :     SwAutoCompleteStringPtrDeque aLRULst;
      43             : 
      44             :     SwAutoCompleteWord_Impl* pImpl;
      45             :     sal_uInt16 nMaxCount, nMinWrdLen;
      46             :     bool bLockWordLst;
      47             : 
      48             :     void DocumentDying(const SwDoc& rDoc);
      49             : public:
      50             :     SwAutoCompleteWord( sal_uInt16 nWords = 500, sal_uInt16 nMWrdLen = 10 );
      51             :     ~SwAutoCompleteWord();
      52             : 
      53             :     bool InsertWord( const String& rWord, SwDoc& rDoc );
      54             : 
      55             :     const String& operator[](size_t n) const
      56             :         { return m_WordList[n]->GetAutoCompleteString(); }
      57             : 
      58         470 :     bool IsLockWordLstLocked() const           { return bLockWordLst; }
      59           0 :     void SetLockWordLstLocked( bool bFlag ) { bLockWordLst = bFlag; }
      60             : 
      61             :     void SetMaxCount( sal_uInt16 n );
      62             : 
      63           0 :     sal_uInt16 GetMinWordLen() const                { return nMinWrdLen; }
      64             :     void SetMinWordLen( sal_uInt16 n );
      65             : 
      66           0 :     const editeng::SortedAutoCompleteStrings& GetWordList() const
      67           0 :         { return m_WordList; }
      68             : 
      69             :     void CheckChangedList(const editeng::SortedAutoCompleteStrings& rNewLst);
      70             : 
      71             :     // Resets the current position within the tree to its root node.
      72             :     void returnToRoot();
      73             : 
      74             :     // Advances to a given node within the AutoComplete tree.
      75             :     void gotoNode(OUString sNode);
      76             : 
      77             :     // Advances from the current position towards the node keyed with cKey.
      78             :     void advance(const sal_Unicode cKey);
      79             : 
      80             :     // Goes back one char within the tree, except if the current node is already the root node.
      81             :     void goBack();
      82             : 
      83             :     // Returns all words matching a given prefix aMatch. If bIgnoreCurrentPos is set, the current
      84             :     // position within the tree is ignored and replaced by aMatch.
      85             :     bool GetWordsMatching(String aMatch, std::vector<String>& aWords, bool bIgnoreCurrentPos) const;
      86             : };
      87             : 
      88             : 
      89             : #endif
      90             : 
      91             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */