API Documentation
Loading...
Searching...
No Matches
CommandLockObject Class Reference

Used with DesignObjectLookups to lock the application for a critical process. Will potentially. More...

#include <CommandLock.h>

Collaboration diagram for CommandLockObject:
[legend]

Public Member Functions

 CommandLockObject (DesignCommandManager *manager, const TranslatedString &title=TranslatedString())
 
const TranslatedString hint () const
 
bool isLocked () const
 
void lock ()
 
void setHint (const TranslatedString &title)
 
void setTitle (const TranslatedString &title)
 
const TranslatedString title () const
 
void tryLock ()
 
void unlock ()
 
 ~CommandLockObject ()
 

Protected Attributes

TranslatedString m_hint
 
UUID m_id
 
DesignCommandManagerm_manager
 
TranslatedString m_title
 

Detailed Description

Used with DesignObjectLookups to lock the application for a critical process. Will potentially.


display the title to the end user.

Constructor & Destructor Documentation

◆ CommandLockObject()

◆ ~CommandLockObject()

Member Function Documentation

◆ hint()

const TranslatedString hint ( ) const

◆ isLocked()

bool isLocked ( ) const

◆ lock()

void lock ( )

◆ setHint()

void setHint ( const TranslatedString & title)

◆ setTitle()

void setTitle ( const TranslatedString & title)

◆ title()

const TranslatedString title ( ) const

◆ tryLock()

void tryLock ( )

◆ unlock()

void unlock ( )

Member Data Documentation

◆ m_hint

TranslatedString m_hint
protected

◆ m_id

UUID m_id
protected

◆ m_manager

DesignCommandManager* m_manager
protected

◆ m_title

TranslatedString m_title
protected

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