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

An Exception thrown when the user cancels an operation. This is not a true error but designed to be used in control paths that allow users to cancel activities. More...

#include <Exception.h>

Inheritance diagram for CancelException:
[legend]
Collaboration diagram for CancelException:
[legend]

Public Member Functions

 CancelException (const TranslatedString &message)
 
- Public Member Functions inherited from Exception
 Exception (const std::exception &exception)
 
 Exception (const String &title, const bool &capture_stack=true)
 
 Exception (const TranslatedString &title, const bool &capture_stack=true)
 
 Exception (const TranslatedString &title, const TranslatedString &message, const bool &capture_stack=true)
 
virtual const TranslatedStringgetCategory () const
 
virtual TranslatedString getMessage () const
 
virtual uint04 getPriority () const
 
virtual const TranslatedStringgetTitle () const
 
UUID id () const
 
void printToLogger ()
 
void setCategory (const TranslatedString &category)
 
virtual void setMessage (const TranslatedString &message)
 
void setThread (const String &thread)
 
void setTitle (const TranslatedString &title)
 
virtual const StringstackTrace () const
 
const Stringthread () const
 
virtual ~Exception ()=default
 

Additional Inherited Members

- Protected Attributes inherited from Exception
TranslatedString m_category
 
TranslatedString m_message
 
uint04 m_priority
 
String m_stack_trace
 
String m_thread
 
TranslatedString m_title
 

Detailed Description

An Exception thrown when the user cancels an operation. This is not a true error but designed to be used in control paths that allow users to cancel activities.


Constructor & Destructor Documentation

◆ CancelException()

CancelException ( const TranslatedString & message)

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