sd/source/ui/inc/SpellDialogChildWindow.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: SpellDialogChildWindow.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SD_SPELL_DIALOG_CHILD_WINDOW_HXX
  32 #define SD_SPELL_DIALOG_CHILD_WINDOW_HXX
  33
  34 #include <svx/SpellDialogChildWindow.hxx>
  35
  36
  37 namespace sd {
  38
  39 class Outliner;
  40
  41 /** This derivation of the ::svx::SpellDialogChildWindow base class
  42     provides Draw and Impress specific implementations of
  43     GetNextWrongSentence() and ApplyChangedSentence().
  44 */
  45 class SpellDialogChildWindow
  46     : public ::svx::SpellDialogChildWindow
  47 {
  48 public:
  49     SpellDialogChildWindow (
  50         ::Window* pParent,
  51         USHORT nId,
  52         SfxBindings* pBindings,
  53         SfxChildWinInfo* pInfo);
  54     virtual ~SpellDialogChildWindow (void);
  55
  56     /** This method makes the one from the base class public so that
  57         it can be called from the view shell when one is created.
  58     */
  59     virtual void InvalidateSpellDialog (void);
  60
  61     SFX_DECL_CHILDWINDOW(SpellDialogChildWindow);
  62
  63 protected:
  64     /** Iterate over the sentences in all text shapes and stop at the
  65         next sentence with spelling errors. While doing so the view
  66         mode may be changed and text shapes are set into edit mode.
  67     */
  68     virtual ::svx::SpellPortions GetNextWrongSentence (void);
  69
  70     /** This method is responsible for merging corrections made in the
  71         spelling dialog back into the document.
  72     */
  73     virtual void ApplyChangedSentence (const ::svx::SpellPortions& rChanged);
  74     virtual void GetFocus (void);
  75     virtual void LoseFocus (void);
  76
  77 private:
  78     /** This outliner is used to do the main work of iterating over a
  79         document and finding sentences with spelling errors.
  80     */
  81     Outliner* mpSdOutliner;
  82
  83     /** When this flag is <TRUE/> then eventually we have to destroy
  84         the outliner in mpSdOutliner.
  85     */
  86     bool mbOwnOutliner;
  87
  88     /** Provide an outliner in the mpSdOutliner data member.  When the
  89         view shell has changed since the last call this include the
  90         deletion/release of formerly created/obtained one prior to
  91         construction/obtaining of a new one.
  92     */
  93     void ProvideOutliner (void);
  94 };
  95
  96 } // end of namespace ::sd
  97
  98 #endif