TfNotice::Key Class Reference

#include <notice.h>

Public Member Functions
	Key ()
bool	IsValid () const
	operator bool () const

Friends
class	Tf_NoticeRegistry
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 240 of file notice.h.

Constructor & Destructor Documentation

TfNotice::Key::Key ( )

inline

Definition at line 242 of file notice.h.

Member Function Documentation

bool TfNotice::Key::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 248 of file notice.h.

TfNotice::Key::operator bool ( ) const

inline

Does this key refer to a valid notification?

The boolean operator is identical to IsValid() above.

Definition at line 255 of file notice.h.

Friends And Related Function Documentation

friend class Tf_NoticeRegistry

friend

Definition at line 264 of file notice.h.

friend class TfNotice

friend

Definition at line 265 of file notice.h.

---

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

• pxr/base/tf/notice.h