[Libreoffice-commits] core.git: sc/source

[Eike Rathke]

 sc/source/ui/inc/docsh.hxx |   22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

New commits:
commit a049f8a1175d12182b9b5be90a3098a5b5d161ca
Author: Eike Rathke <erack at redhat.com>
Date:   Fri Aug 9 22:34:09 2013 +0200

    change documentation of ScDocShellModificator to something comprehensible
    
    Original meaning got lost during translation.
    
    Change-Id: I23c6ab093bf6ddf45b55f35a0d15fe7a1d927723

diff --git a/sc/source/ui/inc/docsh.hxx b/sc/source/ui/inc/docsh.hxx
index 0e7f16b..3234992 100644
--- a/sc/source/ui/inc/docsh.hxx
+++ b/sc/source/ui/inc/docsh.hxx
@@ -441,13 +441,21 @@ SV_DECL_REF(ScDocShell)
 SV_IMPL_REF(ScDocShell)
 
 
-/** Create before modifications of the document and then destroy.
-    If noted in the ctor AutoCalcShellDisabled and IdleDisabled,
-    switches them off and restores the dtor AutoCalcShellDisabled
-    also before a ScDocShell SetDocumentModified.
-    Call SetDocumentModified after instead of the ScDocShell.
-    In the dtor, if ScDocShell bDocumentModifiedPending is set and
-    bAutoCalcShellDisabled is not set, then SetDocumentModified is called. */
+/** Create before modifications of the document and destroy thereafter.
+    Call SetDocumentModified() at an instance of this class instead of at
+    ScDocShell.
+
+    Remembers in the ctor ScDocument's AutoCalcShellDisabled and IdleDisabled,
+    switches them off and restores them in the dtor, AutoCalcShellDisabled
+    also before a ScDocShell::SetDocumentModified() call if necessary.
+    In the dtor, if ScDocShell's bDocumentModifiedPending is set and
+    bAutoCalcShellDisabled is not set, then ScDocShell::SetDocumentModified()
+    is called.
+
+    Several instances can be used in nested calls to ScDocFunc or ScDocShell
+    methods to avoid multiple modified status changes, only the last instance
+    destroyed calls ScDocShell::SetDocumentModified().
+ */
 class SC_DLLPUBLIC ScDocShellModificator
 {
             ScDocShell&     rDocShell;