1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef IGRAMMARCONTACT_HXX_INCLUDED 25*b1cdbd2cSJim Jagielski #define IGRAMMARCONTACT_HXX_INCLUDED 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski struct SwPosition; 28*b1cdbd2cSJim Jagielski class SwTxtNode; 29*b1cdbd2cSJim Jagielski class SwGrammarMarkUp; 30*b1cdbd2cSJim Jagielski class SwDoc; 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski /** Organizer of the contact between SwTxtNodes and grammar checker 33*b1cdbd2cSJim Jagielski */ 34*b1cdbd2cSJim Jagielski class IGrammarContact 35*b1cdbd2cSJim Jagielski { 36*b1cdbd2cSJim Jagielski public: 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski /** Update cursor position reacts to a change of the current input cursor 39*b1cdbd2cSJim Jagielski As long as the cursor in inside a paragraph, the grammar checking does 40*b1cdbd2cSJim Jagielski not show new grammar faults. When the cursor leaves the paragraph, these 41*b1cdbd2cSJim Jagielski faults are shown. 42*b1cdbd2cSJim Jagielski @returns void 43*b1cdbd2cSJim Jagielski */ 44*b1cdbd2cSJim Jagielski virtual void updateCursorPosition( const SwPosition& rNewPos ) = 0; 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski /** getGrammarCheck checks if the given text node is blocked by the current cursor 47*b1cdbd2cSJim Jagielski if not, the normal markup list is returned 48*b1cdbd2cSJim Jagielski if blocked, it will return a markup list "proxy" 49*b1cdbd2cSJim Jagielski @returns a markup list (grammar) for the given SwTxtNode 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielski virtual SwGrammarMarkUp* getGrammarCheck( SwTxtNode& rTxtNode, bool bCreate ) = 0; 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski /** finishGrammarCheck() has to be called if a grammar checking has been completed 54*b1cdbd2cSJim Jagielski for a text node. If this text node has not been hided by the current proxy list 55*b1cdbd2cSJim Jagielski it will be repainted. Otherwise the proxy list replaces the old list and the 56*b1cdbd2cSJim Jagielski repaint will be triggered by a timer 57*b1cdbd2cSJim Jagielski @returns void 58*b1cdbd2cSJim Jagielski */ 59*b1cdbd2cSJim Jagielski virtual void finishGrammarCheck( SwTxtNode& rTxtNode ) = 0; 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski public: ~IGrammarContact()62*b1cdbd2cSJim Jagielski virtual ~IGrammarContact() {} 63*b1cdbd2cSJim Jagielski }; 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski /** Factory for a grammar contact 66*b1cdbd2cSJim Jagielski @returns a new created grammar contact object 67*b1cdbd2cSJim Jagielski */ 68*b1cdbd2cSJim Jagielski IGrammarContact* createGrammarContact(); 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski /* Helper functions */ 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski /** getGrammarContact() delivers the grammar contact of the document (for a given textnode) 73*b1cdbd2cSJim Jagielski @returns grammar contact 74*b1cdbd2cSJim Jagielski */ 75*b1cdbd2cSJim Jagielski IGrammarContact* getGrammarContact( const SwTxtNode& ); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski /** finishGrammarCheck() calls the same function of the grammar contact of the document (for a given textnode) 78*b1cdbd2cSJim Jagielski @returns void 79*b1cdbd2cSJim Jagielski */ 80*b1cdbd2cSJim Jagielski void finishGrammarCheck( SwTxtNode& ); 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski #endif // IGRAMMARCONTACT_HXX_INCLUDED 83*b1cdbd2cSJim Jagielski 84