TfNotice::Key Class Reference

Handle-object returned by TfNotice::Register(). More...

#include <notice.h>

Public Member Functions
bool	IsValid () const
	Does this key refer to a valid notification?
	operator bool () const
	Does this key refer to a valid notification?

Friends
class	TfNotice

Detailed Description

Handle-object returned by TfNotice::Register().

When a listener is registered by TfNotice::Register(), an object of type TfNotice::Key is returned; this key object can be given to Revoke() to subsequently unregister the listener with respect to that particular notice type and callback method.

Definition at line 243 of file notice.h.

Constructor & Destructor Documentation

Key()

Key ( )

inline

Definition at line 245 of file notice.h.

Member Function Documentation

IsValid()

bool IsValid ( ) const

inline

Does this key refer to a valid notification?

IsValid will return true if this key refers to a currently active notification. Revoking the key will make it invalid again.

Definition at line 251 of file notice.h.

operator bool()

operator bool ( ) const

inline

Does this key refer to a valid notification?

The boolean operator is identical to IsValid() above.

Definition at line 258 of file notice.h.

Friends And Related Function Documentation

TfNotice

friend class TfNotice

friend

Definition at line 268 of file notice.h.

---

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

• pxr/base/tf/notice.h