sw/inc/acmplwrd.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 INCLUDED_SW_INC_ACMPLWRD_HXX
  21 #define INCLUDED_SW_INC_ACMPLWRD_HXX
  22
  23 #include <deque>
  24
  25 #include <editeng/swafopt.hxx>
  26 #include <editeng/Trie.hxx>
  27 #include <rtl/ustring.hxx>
  28
  29 class SwDoc;
  30 class SwAutoCompleteWord_Impl;
  31 class SwAutoCompleteClient;
  32 class SwAutoCompleteString;
  33
  34 typedef std::deque<SwAutoCompleteString*> SwAutoCompleteStringPtrDeque;
  35
  36 class SwAutoCompleteWord
  37 {
  38     friend class SwAutoCompleteClient;
  39
  40     /// contains extended strings carrying source information
  41     editeng::SortedAutoCompleteStrings m_WordList;
  42     editeng::Trie m_LookupTree;
  43     SwAutoCompleteStringPtrDeque aLRULst;
  44
  45     SwAutoCompleteWord_Impl* pImpl;
  46     sal_uInt16 nMaxCount, nMinWrdLen;
  47     bool bLockWordLst;
  48
  49     void DocumentDying(const SwDoc& rDoc);
  50 public:
  51     SwAutoCompleteWord( sal_uInt16 nWords = 500, sal_uInt16 nMWrdLen = 10 );
  52     ~SwAutoCompleteWord();
  53
  54     bool InsertWord( const OUString& rWord, SwDoc& rDoc );
  55
  56     const OUString& operator[](size_t n) const
  57         { return m_WordList[n]->GetAutoCompleteString(); }
  58
  59     bool IsLockWordLstLocked() const           { return bLockWordLst; }
  60     void SetLockWordLstLocked( bool bFlag ) { bLockWordLst = bFlag; }
  61
  62     void SetMaxCount( sal_uInt16 n );
  63
  64     sal_uInt16 GetMinWordLen() const                { return nMinWrdLen; }
  65     void SetMinWordLen( sal_uInt16 n );
  66
  67     const editeng::SortedAutoCompleteStrings& GetWordList() const
  68         { return m_WordList; }
  69
  70     void CheckChangedList(const editeng::SortedAutoCompleteStrings& rNewLst);
  71
  72     // Returns all words matching a given prefix aMatch.
  73     bool GetWordsMatching(const OUString& aMatch, std::vector<OUString>& aWords) const;
  74 };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */