xref: /core/sw/inc/acmplwrd.hxx (revision f41868a5)
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 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 m_aLRUList;
44 
45     std::unique_ptr<SwAutoCompleteWord_Impl> m_pImpl;
46     editeng::SortedAutoCompleteStrings::size_type m_nMaxCount;
47     sal_uInt16 m_nMinWordLen;
48     bool m_bLockWordList;
49 
50     void DocumentDying(const SwDoc& rDoc);
51 public:
52     SwAutoCompleteWord(
53         editeng::SortedAutoCompleteStrings::size_type nWords,
54         sal_uInt16 nMWrdLen );
55     ~SwAutoCompleteWord();
56 
57     bool InsertWord( const OUString& rWord, SwDoc& rDoc );
58 
IsLockWordLstLocked() const59     bool IsLockWordLstLocked() const           { return m_bLockWordList; }
SetLockWordLstLocked(bool bFlag)60     void SetLockWordLstLocked( bool bFlag ) { m_bLockWordList = bFlag; }
61 
62     void SetMaxCount( editeng::SortedAutoCompleteStrings::size_type n );
63 
GetMinWordLen() const64     sal_uInt16 GetMinWordLen() const                { return m_nMinWordLen; }
65     void SetMinWordLen( sal_uInt16 n );
66 
GetWordList() const67     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(std::u16string_view aMatch, std::vector<OUString>& aWords) const;
74 };
75 
76 #endif
77 
78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
79