Mapper  0.9.0
API documentation
Public Member Functions | List of all members
OpenOrienteering::TextObjectEditorHelper::BatchEdit Class Reference

Establishes a scoped batch edit context and handles state change signals. More...

#include <text_object_editor_helper.h>

Public Member Functions

 BatchEdit (not_null< TextObjectEditorHelper *> editor, int actions=CommitPreedit|UpdateInputProperties)
 Constructor. More...
 
 BatchEdit (const BatchEdit &)=delete
 
 ~BatchEdit ()
 Destructor. More...
 
BatchEditoperator= (const BatchEdit &)=delete
 

Detailed Description

Establishes a scoped batch edit context and handles state change signals.

Batch edits are sequences of possibly nested operations which change the state which is observable by outside objects. Scoped objects of this class take care of sending messages to observers only at the beginning and end of a complex editing operation. This helps to properly deal with the input method state.

Constructor & Destructor Documentation

◆ BatchEdit() [1/2]

OpenOrienteering::TextObjectEditorHelper::BatchEdit::BatchEdit ( not_null< TextObjectEditorHelper *>  editor,
int  actions = CommitPreedit | UpdateInputProperties 
)

Constructor.

Only the constructor of the outermost scope calls TextObjectEditorHelper::commitPreedit() if CommitPreedit is set.

◆ BatchEdit() [2/2]

OpenOrienteering::TextObjectEditorHelper::BatchEdit::BatchEdit ( const BatchEdit )
delete

◆ ~BatchEdit()

OpenOrienteering::TextObjectEditorHelper::BatchEdit::~BatchEdit ( )

Destructor.

The given actions have no effected in a nested batch edit context. Only the destructor of the outermost scope calls TextObjectEditorHelper::commitStateChange().

Member Function Documentation

◆ operator=()

BatchEdit& OpenOrienteering::TextObjectEditorHelper::BatchEdit::operator= ( const BatchEdit )
delete

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