LibreOffice Module dbaccess (master) 1
Public Types | Public Member Functions | Private Attributes | List of all members
dbaccess::DocumentGuard Class Reference

an extended version of the ModelMethodGuard, which also cares for the initialization state of the document More...

#include <databasedocument.hxx>

Inheritance diagram for dbaccess::DocumentGuard:
[legend]
Collaboration diagram for dbaccess::DocumentGuard:
[legend]

Public Types

enum  InitMethod_ { InitMethod }
 
enum  DefaultMethod_ { DefaultMethod }
 
enum  MethodUsedDuringInit_ { MethodUsedDuringInit }
 
enum  MethodWithoutInit_ { MethodWithoutInit }
 

Public Member Functions

 DocumentGuard (const ODatabaseDocument &_document, DefaultMethod_)
 constructs the guard More...
 
 DocumentGuard (const ODatabaseDocument &_document, InitMethod_)
 constructs the guard More...
 
 DocumentGuard (const ODatabaseDocument &_document, MethodUsedDuringInit_)
 constructs the guard More...
 
 DocumentGuard (const ODatabaseDocument &_document, MethodWithoutInit_)
 constructs the guard More...
 
void clear ()
 
void reset ()
 

Private Attributes

const ODatabaseDocumentm_document
 

Additional Inherited Members

- Private Member Functions inherited from dbaccess::ModelMethodGuard
 ModelMethodGuard (const ModelDependentComponent &_component)
 constructs the guard More...
 
void clear ()
 
void reset ()
 

Detailed Description

an extended version of the ModelMethodGuard, which also cares for the initialization state of the document

Definition at line 639 of file databasedocument.hxx.

Member Enumeration Documentation

◆ DefaultMethod_

Enumerator
DefaultMethod 

Definition at line 648 of file databasedocument.hxx.

◆ InitMethod_

Enumerator
InitMethod 

Definition at line 642 of file databasedocument.hxx.

◆ MethodUsedDuringInit_

Enumerator
MethodUsedDuringInit 

Definition at line 654 of file databasedocument.hxx.

◆ MethodWithoutInit_

Enumerator
MethodWithoutInit 

Definition at line 660 of file databasedocument.hxx.

Constructor & Destructor Documentation

◆ DocumentGuard() [1/4]

dbaccess::DocumentGuard::DocumentGuard ( const ODatabaseDocument _document,
DefaultMethod_   
)
inline

constructs the guard

Parameters
_documentthe ODatabaseDocument instance
Exceptions
css::lang::DisposedExceptionIf the given component is already disposed
css::lang::NotInitializedExceptionif the given component is not yet initialized

Definition at line 678 of file databasedocument.hxx.

References dbaccess::ODatabaseDocument::checkInitialized(), and m_document.

◆ DocumentGuard() [2/4]

dbaccess::DocumentGuard::DocumentGuard ( const ODatabaseDocument _document,
InitMethod_   
)
inline

constructs the guard

Parameters
_documentthe ODatabaseDocument instance
Exceptions
css::lang::DisposedExceptionIf the given component is already disposed
css::frame::DoubleInitializationExceptionif the given component is already initialized, or currently being initialized.

Definition at line 696 of file databasedocument.hxx.

References dbaccess::ODatabaseDocument::checkNotInitialized(), and m_document.

◆ DocumentGuard() [3/4]

dbaccess::DocumentGuard::DocumentGuard ( const ODatabaseDocument _document,
MethodUsedDuringInit_   
)
inline

constructs the guard

Parameters
_documentthe ODatabaseDocument instance
Exceptions
css::lang::DisposedExceptionIf the given component is already disposed
css::lang::NotInitializedExceptionif the component is still uninitialized, and not in the initialization phase currently.

Definition at line 715 of file databasedocument.hxx.

References dbaccess::ODatabaseDocument::checkNotUninitialized(), and m_document.

◆ DocumentGuard() [4/4]

dbaccess::DocumentGuard::DocumentGuard ( const ODatabaseDocument _document,
MethodWithoutInit_   
)
inline

constructs the guard

Parameters
_documentthe ODatabaseDocument instance
Exceptions
css::lang::DisposedExceptionIf the given component is already disposed

Definition at line 730 of file databasedocument.hxx.

Member Function Documentation

◆ clear()

void dbaccess::DocumentGuard::clear ( )
inline

◆ reset()

void dbaccess::DocumentGuard::reset ( )
inline

Member Data Documentation

◆ m_document

const ODatabaseDocument& dbaccess::DocumentGuard::m_document
private

Definition at line 748 of file databasedocument.hxx.

Referenced by DocumentGuard(), and reset().


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