DD::Image::OpMessage Class Reference

This class encapsulates a text message to the user produced by an op. More...

Public Types

enum  Type { eWarning, eError, eDebug }
 
enum  Source { eFromOp, eFromKnob }
 
enum  EnablePopUp { ePU_Disable, ePU_Enable }
 
enum  Empty { eEmpty }
 
typedef unsigned ID
 

Public Member Functions

 OpMessage (Type lType, Source lSource, const std::string &lrText, EnablePopUp lEnablePopUp=ePU_Disable)
 
 OpMessage (Empty lEmpty)
 Use this to explicitly create an empty op message.
 
Type getType () const
 
Source getSource () const
 
bool isError () const
 
const std::string & getText () const
 
const time_t & getTime () const
 
ID getID () const
 
bool isPopUpEnabled () const
 
void disablePopUp () const
 
bool isNew () const
 
void setNew (bool lIsNew) const
 
void setPopUpsEnabled (bool lEnabled) const
 Avoid using this if possible. It is only provided for use in the Op base class.
 
bool operator== (const OpMessage &lrOther) const
 
bool operator!= (const OpMessage &lrOther) const
 
bool matchesID (ID lID) const
 
bool isEmpty () const
 
bool isEquivalentTo (const OpMessage *lpOther) const
 Messages are equivalent iff they will look equivalent to the user (other than message time)
 
void clear ()
 

Detailed Description

This class encapsulates a text message to the user produced by an op.



©2021 The Foundry Visionmongers, Ltd. All Rights Reserved.
www.thefoundry.co.uk