sw/inc/IGrammarContact.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_IGRAMMARCONTACT_HXX
  21 #define INCLUDED_SW_INC_IGRAMMARCONTACT_HXX
  22
  23 struct SwPosition;
  24 class SwTextNode;
  25 class SwGrammarMarkUp;
  26 class SwDoc;
  27
  28 /** Organizer of the contact between SwTextNodes and grammar checker
  29 */
  30 class IGrammarContact
  31 {
  32 public:
  33
  34     /** Update cursor position reacts to a change of the current input cursor
  35         As long as the cursor in inside a paragraph, the grammar checking does
  36         not show new grammar faults. When the cursor leaves the paragraph, these
  37         faults are shown.
  38     @returns void
  39     */
  40     virtual void updateCursorPosition( const SwPosition& rNewPos ) = 0;
  41
  42     /** getGrammarCheck checks if the given text node is blocked by the current cursor
  43         if not, the normal markup list is returned
  44         if blocked, it will return a markup list "proxy"
  45     @returns a markup list (grammar) for the given SwTextNode
  46     */
  47     virtual SwGrammarMarkUp* getGrammarCheck( SwTextNode& rTextNode, bool bCreate ) = 0;
  48
  49     /** finishGrammarCheck() has to be called if a grammar checking has been completed
  50         for a text node. If this text node has not been hided by the current proxy list
  51         it will be repainted. Otherwise the proxy list replaces the old list and the
  52         repaint will be triggered by a timer
  53     @returns void
  54     */
  55     virtual void finishGrammarCheck( SwTextNode& rTextNode ) = 0;
  56
  57 public:
  58     virtual ~IGrammarContact() {}
  59 };
  60
  61 /** Factory for a grammar contact
  62 @returns a new created grammar contact object
  63 */
  64 IGrammarContact* createGrammarContact();
  65
  66 /* Helper functions */
  67
  68 /** getGrammarContact() delivers the grammar contact of the document (for a given textnode)
  69 @returns grammar contact
  70 */
  71 IGrammarContact* getGrammarContact( const SwTextNode& );
  72
  73 /** finishGrammarCheck() calls the same function of the grammar contact of the document (for a given textnode)
  74 @returns void
  75 */
  76 void finishGrammarCheck( SwTextNode& );
  77
  78 #endif // INCLUDED_SW_INC_IGRAMMARCONTACT_HXX
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */