LibreOffice Module sw (master)  1
IGrammarContact.hxx
Go to the documentation of this file.
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_IGRAMMARCONTACT_HXX
21 #define INCLUDED_SW_INC_IGRAMMARCONTACT_HXX
22 
23 struct SwPosition;
24 class SwTextNode;
25 class SwGrammarMarkUp;
26 
30 {
31 public:
32 
39  virtual void updateCursorPosition( const SwPosition& rNewPos ) = 0;
40 
46  virtual SwGrammarMarkUp* getGrammarCheck( SwTextNode& rTextNode, bool bCreate ) = 0;
47 
54  virtual void finishGrammarCheck( SwTextNode& rTextNode ) = 0;
55 
56 public:
57  virtual ~IGrammarContact() {}
58 };
59 
64 
65 /* Helper functions */
66 
71 
76 
77 #endif // INCLUDED_SW_INC_IGRAMMARCONTACT_HXX
78 
79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual void finishGrammarCheck(SwTextNode &rTextNode)=0
finishGrammarCheck() has to be called if a grammar checking has been completed for a text node...
Marks a position in the document model.
Definition: pam.hxx:35
virtual void updateCursorPosition(const SwPosition &rNewPos)=0
Update cursor position reacts to a change of the current input cursor As long as the cursor in inside...
virtual SwGrammarMarkUp * getGrammarCheck(SwTextNode &rTextNode, bool bCreate)=0
getGrammarCheck checks if the given text node is blocked by the current cursor if not...
IGrammarContact * getGrammarContact(const SwTextNode &)
getGrammarContact() delivers the grammar contact of the document (for a given textnode) ...
Definition: docnew.cxx:774
void finishGrammarCheck(SwTextNode &)
finishGrammarCheck() calls the same function of the grammar contact of the document (for a given text...
virtual ~IGrammarContact()
SwTextNode is a paragraph in the document model.
Definition: ndtxt.hxx:79
Organizer of the contact between SwTextNodes and grammar checker.
IGrammarContact * createGrammarContact()
Factory for a grammar contact.