This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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 239 of file notice.h.

Constructor & Destructor Documentation

◆ Key()

Key ( )
inline

Definition at line 241 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 247 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 254 of file notice.h.

Friends And Related Function Documentation

◆ TfNotice

friend class TfNotice
friend

Definition at line 264 of file notice.h.


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