#include <KisInputActionGroup.h>

Public Member Functions
	KisInputActionGroupsMaskGuard (KisInputActionGroupsMaskInterface::SharedInterface sharedInterface, KisInputActionGroupsMask mask)

	~KisInputActionGroupsMaskGuard ()

Private Attributes
KisInputActionGroupsMask	m_oldMask

KisInputActionGroupsMaskInterface::SharedInterface	m_sharedInterface

Detailed Description

A RAII wrapper for setting the input actions mask on the masking interface (which is usually a canvas). In constructor the guard saves the previous mask value and resets it to the new one. In destructor the guard restores the old mask value.

Definition at line 56 of file KisInputActionGroup.h.

Constructor & Destructor Documentation

◆ KisInputActionGroupsMaskGuard()

KisInputActionGroupsMaskGuard::KisInputActionGroupsMaskGuard	(	KisInputActionGroupsMaskInterface::SharedInterface	sharedInterface,
		KisInputActionGroupsMask	mask )

Create a guard and set a new mask mask onto object. The old mask value is saved in the guard itself.

Definition at line 12 of file KisInputActionGroup.cpp.

    : m_sharedInterface(sharedInterface),
      m_oldMask(sharedInterface->inputActionGroupsMask())
{
    m_sharedInterface->setInputActionGroupsMask(mask);
}

References m_sharedInterface.

◆ ~KisInputActionGroupsMaskGuard()

KisInputActionGroupsMaskGuard::~KisInputActionGroupsMaskGuard ( )

Destroy the guard and reset the mask value to the old value (if masking interface wasn't deleted)

Definition at line 19 of file KisInputActionGroup.cpp.

                                                              {
    m_sharedInterface->setInputActionGroupsMask(m_oldMask);
}

References m_oldMask, and m_sharedInterface.

Member Data Documentation

◆ m_oldMask

KisInputActionGroupsMask KisInputActionGroupsMaskGuard::m_oldMask

private

Definition at line 75 of file KisInputActionGroup.h.

◆ m_sharedInterface

KisInputActionGroupsMaskInterface::SharedInterface KisInputActionGroupsMaskGuard::m_sharedInterface

private

Pointer to the interface to be updated on delete

Definition at line 74 of file KisInputActionGroup.h.

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

libs/ui/input/KisInputActionGroup.h
libs/ui/input/KisInputActionGroup.cpp

Public Member Functions