All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TfPyModuleWasLoaded Class Reference

A TfNotice that is sent when a script module is loaded. More...

+ Inheritance diagram for TfPyModuleWasLoaded:

Public Member Functions

 TfPyModuleWasLoaded (std::string const &name)
 
std::string const & GetName ()
 Return the name of the module that was loaded. More...
 
- Public Member Functions inherited from TfNotice
TF_API size_t Send () const
 Deliver the notice to interested listeners, returning the number of interested listeners. More...
 
template<typename SenderPtr >
size_t Send (SenderPtr const &s) const
 Deliver the notice to interested listeners, returning the number of interested listeners. More...
 
TF_API size_t SendWithWeakBase (const TfWeakBase *senderWeakBase, const void *senderUniqueId, const std::type_info &type) const
 Variant of Send() that takes a specific sender in the form of a TfWeakBase pointer and a typeid. More...
 

Additional Inherited Members

- Public Types inherited from TfNotice
typedef TfWeakPtr< ProbeWeakProbePtr
 
typedef std::vector< KeyKeys
 A TfNotice::Key container. More...
 
- Static Public Member Functions inherited from TfNotice
static void InsertProbe (const WeakProbePtr &probe)
 Register a probe that will be invoked when notices are sent and delivered. More...
 
static void RemoveProbe (const WeakProbePtr &probe)
 Remove a probe that was previously registered with InsertProbe. More...
 
template<class LPtr , class MethodPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method)
 Register a listener as being interested in a TfNotice. More...
 
template<class LPtr , class MethodPtr , class SenderPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method, SenderPtr const &sender)
 
template<class LPtr , class MethodPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method, const TfType &noticeType, const TfAnyWeakPtr &sender)
 
static TF_API bool Revoke (TfNotice::Key &key)
 Revoke interest by a listener. More...
 
static TF_API void Revoke (TfNotice::Keys *keys)
 Revoke interest by listeners. More...
 

Detailed Description

A TfNotice that is sent when a script module is loaded.

Since many modules may be loaded at once, listeners are encouraged to defer work triggered by this notice to the end of an application iteration. This, of course, is good practice in general.

Definition at line 43 of file pyModuleNotice.h.

Member Function Documentation

std::string const& GetName ( )
inline

Return the name of the module that was loaded.

Definition at line 51 of file pyModuleNotice.h.


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