LibreOffice Module sc (master) 1
Public Member Functions | Public Attributes | List of all members
ScMutationGuard Struct Reference

A pretty assertion that checks that the relevant bits in the @nFlags are not set on the document at entry and exit. More...

#include <document.hxx>

Collaboration diagram for ScMutationGuard:
[legend]

Public Member Functions

 ScMutationGuard (ScDocument &rDocument, ScMutationGuardFlags nFlags)
 
 ~ScMutationGuard ()
 

Public Attributes

size_t mnFlags
 
ScDocumentmrDocument
 

Detailed Description

A pretty assertion that checks that the relevant bits in the @nFlags are not set on the document at entry and exit.

Its primary use is for debugging threading. As such, an @ScMutationDisable is created to forbid mutation, and this condition is then asserted on at prominent sites that mutate @nFlags.

Definition at line 2757 of file document.hxx.

Constructor & Destructor Documentation

◆ ScMutationGuard()

ScMutationGuard::ScMutationGuard ( ScDocument rDocument,
ScMutationGuardFlags  nFlags 
)
inline

Definition at line 2760 of file document.hxx.

References mnFlags, ScDocument::mnMutationGuardFlags, and mrDocument.

◆ ~ScMutationGuard()

ScMutationGuard::~ScMutationGuard ( )
inline

Definition at line 2767 of file document.hxx.

References mnFlags, ScDocument::mnMutationGuardFlags, and mrDocument.

Member Data Documentation

◆ mnFlags

size_t ScMutationGuard::mnFlags

Definition at line 2771 of file document.hxx.

Referenced by ScMutationGuard(), and ~ScMutationGuard().

◆ mrDocument

ScDocument& ScMutationGuard::mrDocument

Definition at line 2772 of file document.hxx.

Referenced by ScMutationGuard(), and ~ScMutationGuard().


The documentation for this struct was generated from the following file: