1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#include <vcl/timer.hxx>
#include <hints.hxx>
#include <IGrammarContact.hxx>
#include <pam.hxx>
#include <ndtxt.hxx>
#include <SwGrammarMarkUp.hxx>
#include <txtfrm.hxx>
#include <rootfrm.hxx>
#include <viewsh.hxx>
/* SwGrammarContact
This class is responsible for the delayed display of grammar checks when a paragraph is edited
It's a client of the paragraph the cursor points to.
If the cursor position changes, updateCursorPosition has to be called
If the grammar checker wants to set a grammar marker at a paragraph, he has to request
the grammar list from this class. If the requested paragraph is not edited, it returns
the normal grammar list. But if the paragraph is the active one, a proxy list will be returned and
all changes are set in this proxy list. If the cursor leaves the paragraph the proxy list
will replace the old list. If the grammar checker has completed the paragraph ('setChecked')
then a timer is setup which replaces the old list as well.
*/
class SwGrammarContact : public IGrammarContact, public SwClient
{
Timer aTimer;
SwGrammarMarkUp *mpProxyList;
bool mbFinished;
SwTxtNode* getMyTxtNode() { return (SwTxtNode*)GetRegisteredIn(); }
DECL_LINK( TimerRepaint, Timer * );
public:
SwGrammarContact();
~SwGrammarContact() { aTimer.Stop(); delete mpProxyList; }
// (pure) virtual functions of IGrammarContact
virtual void updateCursorPosition( const SwPosition& rNewPos );
virtual SwGrammarMarkUp* getGrammarCheck( SwTxtNode& rTxtNode, bool bCreate );
virtual void finishGrammarCheck( SwTxtNode& rTxtNode );
protected:
// virtual function of SwClient
virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew);
};
SwGrammarContact::SwGrammarContact() : mpProxyList(0), mbFinished( false )
{
aTimer.SetTimeout( 2000 ); // Repaint of grammar check after 'setChecked'
aTimer.SetTimeoutHdl( LINK(this, SwGrammarContact, TimerRepaint) );
}
IMPL_LINK( SwGrammarContact, TimerRepaint, Timer *, pTimer )
{
if( pTimer )
{
pTimer->Stop();
if( GetRegisteredIn() )
{ //Replace the old wrong list by the proxy list and repaint all frames
getMyTxtNode()->SetGrammarCheck( mpProxyList, true );
mpProxyList = 0;
SwTxtFrm::repaintTextFrames( *getMyTxtNode() );
}
}
return 0;
}
/* I'm always a client of the current paragraph */
void SwGrammarContact::updateCursorPosition( const SwPosition& rNewPos )
{
SwTxtNode* pTxtNode = rNewPos.nNode.GetNode().GetTxtNode();
if( pTxtNode != GetRegisteredIn() ) // paragraph has been changed
{
aTimer.Stop();
if( GetRegisteredIn() ) // My last paragraph has been left
{
if( mpProxyList )
{ // replace old list by the proxy list and repaint
getMyTxtNode()->SetGrammarCheck( mpProxyList, true );
SwTxtFrm::repaintTextFrames( *getMyTxtNode() );
}
GetRegisteredInNonConst()->Remove( this ); // good bye old paragraph
mpProxyList = 0;
}
if( pTxtNode )
pTxtNode->Add( this ); // welcome new paragraph
}
}
/* deliver a grammar check list for the given text node */
SwGrammarMarkUp* SwGrammarContact::getGrammarCheck( SwTxtNode& rTxtNode, bool bCreate )
{
SwGrammarMarkUp *pRet = 0;
if( GetRegisteredIn() == &rTxtNode ) // hey, that's my current paragraph!
{ // so you will get a proxy list...
if( bCreate )
{
if( mbFinished )
{
delete mpProxyList;
mpProxyList = 0;
}
if( !mpProxyList )
{
if( rTxtNode.GetGrammarCheck() )
mpProxyList = (SwGrammarMarkUp*)rTxtNode.GetGrammarCheck()->Clone();
else
{
mpProxyList = new SwGrammarMarkUp();
mpProxyList->SetInvalid( 0, STRING_LEN );
}
}
mbFinished = false;
}
pRet = mpProxyList;
}
else
{
pRet = rTxtNode.GetGrammarCheck(); // do you have already a list?
if( bCreate && !pRet ) // do you want to create a list?
{
pRet = new SwGrammarMarkUp();
pRet->SetInvalid( 0, STRING_LEN );
rTxtNode.SetGrammarCheck( pRet );
rTxtNode.SetGrammarCheckDirty( true );
}
}
return pRet;
}
void SwGrammarContact::Modify( const SfxPoolItem* pOld, const SfxPoolItem * )
{
if( !pOld || pOld->Which() != RES_OBJECTDYING )
return;
SwPtrMsgPoolItem *pDead = (SwPtrMsgPoolItem *)pOld;
if( pDead->pObject == GetRegisteredIn() )
{ // if my current paragraph dies, I throw the proxy list away
aTimer.Stop();
GetRegisteredInNonConst()->Remove( this );
delete mpProxyList;
mpProxyList = 0;
}
}
void SwGrammarContact::finishGrammarCheck( SwTxtNode& rTxtNode )
{
if( &rTxtNode != GetRegisteredIn() ) // not my paragraph
SwTxtFrm::repaintTextFrames( rTxtNode ); // can be repainted directly
else
{
if( mpProxyList )
{
mbFinished = true;
aTimer.Start(); // will replace old list and repaint with delay
}
else if( getMyTxtNode()->GetGrammarCheck() )
{ // all grammar problems seems to be gone, no delay needed
getMyTxtNode()->SetGrammarCheck( 0, true );
SwTxtFrm::repaintTextFrames( *getMyTxtNode() );
}
}
}
IGrammarContact* createGrammarContact()
{
return new SwGrammarContact();
}
void finishGrammarCheck( SwTxtNode& rTxtNode )
{
IGrammarContact* pGrammarContact = getGrammarContact( rTxtNode );
if( pGrammarContact )
pGrammarContact->finishGrammarCheck( rTxtNode );
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|