5a23ce8f56781961e3bb32effadf00d251fd1d79
[WebKit-https.git] / Source / WebCore / editing / SpellChecker.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef SpellChecker_h
27 #define SpellChecker_h
28
29 #include "PlatformString.h"
30 #include "TextChecking.h"
31 #include <wtf/RefPtr.h>
32 #include <wtf/Noncopyable.h>
33 #include <wtf/Vector.h>
34
35 namespace WebCore {
36
37 class Frame;
38 class Node;
39 class TextCheckerClient;
40 struct TextCheckingResult;
41
42 class SpellChecker {
43     WTF_MAKE_NONCOPYABLE(SpellChecker);
44 public:
45     explicit SpellChecker(Frame*);
46     ~SpellChecker();
47
48     bool isAsynchronousEnabled() const;
49     bool canCheckAsynchronously(Node*) const;
50     bool isBusy() const;
51     bool isValid(int sequence) const;
52     bool isCheckable(Node*) const;
53     void requestCheckingFor(TextCheckingTypeMask, Node*);
54     void didCheck(int sequence, const Vector<TextCheckingResult>&);
55
56 private:
57     bool initRequest(Node*);
58     void clearRequest();
59     TextCheckerClient* client() const;
60
61     Frame* m_frame;
62
63     RefPtr<Node> m_requestNode;
64     String m_requestText;
65     int m_requestSequence;
66 };
67
68 } // namespace WebCore
69
70 #endif // SpellChecker_h