Adding upstream version 4:24.2.0.upstream/4%24.2.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 115 insertions, 0 deletions

diff --git a/include/svx/SpellDialogChildWindow.hxx b/include/svx/SpellDialogChildWindow.hxx
new file mode 100644
index 0000000000..21ebd227c1
--- /dev/null
+++ b/include/svx/SpellDialogChildWindow.hxx
@@ -0,0 +1,115 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef INCLUDED_SVX_SPELLDIALOGCHILDWINDOW_HXX
+#define INCLUDED_SVX_SPELLDIALOGCHILDWINDOW_HXX
+
+#include <sfx2/childwin.hxx>
+#include <editeng/SpellPortions.hxx>
+#include <svx/svxdllapi.h>
+
+class AbstractSpellDialog;
+
+namespace svx
+{
+/** The child window wrapper of the actual spelling dialog.  To use the
+    spelling dialog in an application you have to do the usual things:
+    <ol>
+    <li>Call this class' RegisterChildWindow() method with the module
+    as second argument that you want the dialog included in.</li>
+    <li>In the SFX_IMPL_INTERFACE implementation of the view shell
+    that wants to use the dialog call RegisterChildWindow()
+    with the id returned by this class' GetChildWindowId()
+    method.</li>
+    <li>Include the item associated with this child window to the SDI
+    description of the view shell.</li>
+    </ol>
+*/
+class SVX_DLLPUBLIC SpellDialogChildWindow : public SfxChildWindow
+{
+    friend class SpellDialog;
+    VclPtr<AbstractSpellDialog> m_xAbstractSpellDialog;
+
+public:
+    SpellDialogChildWindow(vcl::Window* pParent, sal_uInt16 nId, SfxBindings* pBindings);
+    virtual ~SpellDialogChildWindow() override;
+
+protected:
+    /** This abstract method has to be defined by a derived class.  It
+        returns the next wrong sentence.
+        @return
+            returns an empty vector if no error could be found
+    */
+    virtual SpellPortions GetNextWrongSentence(bool bRecheck) = 0;
+
+    /** This abstract method applies the changes made in the spelling dialog
+     to the document.
+     The dialog always updates its settings when it gets the focus. The document
+     can rely on the fact that the methods ApplyChangedSentence() is called for the
+     position that the last GetNextWrongSentence() returned.
+     If 'bRecheck' is set to true then the same sentence should be rechecked once from
+     the start. This should be used to find errors that the user has introduced by
+     manual changes in the edit field, and in order to not miss the still following errors
+     in that sentence.
+    */
+    virtual void ApplyChangedSentence(const SpellPortions& rChanged, bool bRecheck) = 0;
+    /** This methods determines whether the application supports AutoCorrection
+     */
+    virtual bool HasAutoCorrection();
+    /** This method adds a word pair to the AutoCorrection - if available
+     */
+    virtual void AddAutoCorrection(const OUString& rOld, const OUString& rNew,
+                                   LanguageType eLanguage);
+    /** Return the sfx bindings for this child window. They are
+        retrieved from the dialog so they do not have to be stored in
+        this class as well.  The bindings may be necessary to be used
+        by the abstract methods.
+    */
+    /** This method determines if grammar checking is supported
+     */
+    virtual bool HasGrammarChecking();
+    /** determines if grammar checking is switched on
+     */
+    virtual bool IsGrammarChecking();
+    /** switches grammar checking on/off
+     */
+    virtual void SetGrammarChecking(bool bOn);
+
+    SfxBindings& GetBindings() const;
+    /** Set the spell dialog into the 'resume' state. This method should be called
+        to notify the SpellDialog about changes in the document that invalidate the
+        current state which results in disabling most of the dialog controls and presenting
+        a "Resume" button that initiates a reinitialization.
+     */
+    void InvalidateSpellDialog();
+    /** Notifies the ChildWindow about the get focus event. The ChildWindow should no check if
+        the spelling dialog should be set to the 'Resume' state by calling InvalidateSpellDialog()
+     */
+    virtual void GetFocus() = 0;
+    /** Notifies the ChildWindow about the lose focus event. The ChildWindow should use it to save
+        the current selection/state.
+     */
+    virtual void LoseFocus() = 0;
+};
+
+} // end of namespace ::svx
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */