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