Search Toolkit Book for CEvent
CEvent - generic event implementation TODO TODO - Attachments. More...
#include <gui/utils/event.hpp>
Inheritance diagram for CEvent:
Collaboration diagram for CEvent:
Public Types | |
| enum | EEventClass { eEvent_Message } |
| default event classes More... | |
| enum | EEventID { eEvent_LastID = -1 , eEvent_InvalidID = -2 , eEvent_MinClientID = 0 } |
| Predefining event IDs. More... | |
| enum | EOwnershipPolicy { eDelete , eRelease } |
| typedef const char * | TEventTypeInfo |
| typedef CRef< CEvent > | TEventObject |
| typedef Int4 | TEventID |
| typedef CEventHandler | TEventSender |
| typedef Int4 | TEventRefs |
| typedef std::type_info | TAttachmentTypeInfo |
| Public Types inherited from CObject | |
| enum | EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern } |
| Control filling of newly allocated memory. More... | |
| typedef CObjectCounterLocker | TLockerType |
| Default locker type for CRef. More... | |
| typedef atomic< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
Public Member Functions | |
| CEvent () | |
| default ctor More... | |
| CEvent (TEventID eid) | |
| create an event for a given event ID, with event class Unknown More... | |
| CEvent (EEventClass ecl, TEventID eid, TEventSender *sender=NULL) | |
| create an event for a specific event class and ID More... | |
| CEvent (EEventClass ecl, TEventID eid, IEventAttachment *att, EOwnershipPolicy policy, TEventSender *sender) | |
| create an event with all the bells and whistles More... | |
| virtual | ~CEvent (void) |
| virtual dtor More... | |
| const TEventRefs | GetRefs (void) const |
| void | AddRef (void) |
| const TEventID | GetID (void) const |
| Inline Implementation. More... | |
| const EEventClass | GetEventClass (void) const |
| const TEventSender * | GetSender (void) const |
| TEventTypeInfo | GetTypeInfo (void) |
| virtual void | SetAttachment (IEventAttachment *att, EOwnershipPolicy policy) |
| attach an object to the Event More... | |
| virtual IEventAttachment * | GetAttachment (void) |
| virtual bool | HasAttachment (void) const |
| bool | Visit (CEventHandler *handler) |
| Checks whether this event has been visited by the given handler. More... | |
| Public Member Functions inherited from CObject | |
| CObject (void) | |
| Constructor. More... | |
| CObject (const CObject &src) | |
| Copy constructor. More... | |
| virtual | ~CObject (void) |
| Destructor. More... | |
| CObject & | operator= (const CObject &src) THROWS_NONE |
| Assignment operator. More... | |
| bool | CanBeDeleted (void) const THROWS_NONE |
| Check if object can be deleted. More... | |
| bool | IsAllocatedInPool (void) const THROWS_NONE |
| Check if object is allocated in memory pool (not system heap) More... | |
| bool | Referenced (void) const THROWS_NONE |
| Check if object is referenced. More... | |
| bool | ReferencedOnlyOnce (void) const THROWS_NONE |
| Check if object is referenced only once. More... | |
| void | AddReference (void) const |
| Add reference to object. More... | |
| void | RemoveReference (void) const |
| Remove reference to object. More... | |
| void | ReleaseReference (void) const |
| Remove reference without deleting object. More... | |
| virtual void | DoNotDeleteThisObject (void) |
| Mark this object as not allocated in heap – do not delete this object. More... | |
| virtual void | DoDeleteThisObject (void) |
| Mark this object as allocated in heap – object can be deleted. More... | |
| void * | operator new (size_t size) |
| Define new operator for memory allocation. More... | |
| void * | operator new[] (size_t size) |
| Define new[] operator for 'array' memory allocation. More... | |
| void | operator delete (void *ptr) |
| Define delete operator for memory deallocation. More... | |
| void | operator delete[] (void *ptr) |
| Define delete[] operator for memory deallocation. More... | |
| void * | operator new (size_t size, void *place) |
| Define new operator. More... | |
| void | operator delete (void *ptr, void *place) |
| Define delete operator. More... | |
| void * | operator new (size_t size, CObjectMemoryPool *place) |
| Define new operator using memory pool. More... | |
| void | operator delete (void *ptr, CObjectMemoryPool *place) |
| Define delete operator. More... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. More... | |
| Public Member Functions inherited from CDebugDumpable | |
| CDebugDumpable (void) | |
| virtual | ~CDebugDumpable (void) |
| void | DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const |
| void | DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const |
| void | DumpToConsole (void) const |
Protected Attributes | |
| EEventClass | m_Class |
| TEventID | m_ID |
| Event class - to speed up avoiding extra dynamic casts. More... | |
| TEventSender * | m_Sender |
| Defines unique event identity within its C++ class and Event Class. More... | |
| unique_ptr< IEventAttachment > | m_Attachment |
| pointer to the class that sent this event More... | |
| EOwnershipPolicy | m_AttPolicy |
| set< CEventHandler * > | m_Visited |
| list of handler who have seen this event already More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from CObject | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (void) |
| Define method to throw null pointer exception. More... | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (const type_info &type) |
| static EAllocFillMode | GetAllocFillMode (void) |
| static void | SetAllocFillMode (EAllocFillMode mode) |
| static void | SetAllocFillMode (const string &value) |
| Set mode from configuration parameter value. More... | |
| Static Public Member Functions inherited from CDebugDumpable | |
| static void | EnableDebugDump (bool on) |
| Static Public Attributes inherited from CObject | |
| static const TCount | eCounterBitsCanBeDeleted = 1 << 0 |
| Define possible object states. More... | |
| static const TCount | eCounterBitsInPlainHeap = 1 << 1 |
| Heap signature was found. More... | |
| static const TCount | eCounterBitsPlaceMask |
| Mask for 'in heap' state flags. More... | |
| static const int | eCounterStep = 1 << 2 |
| Skip over the "in heap" bits. More... | |
| static const TCount | eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2) |
| Minimal value for valid objects (reference counter is zero) Must be a single bit value. More... | |
| static const TCount | eCounterStateMask |
| Valid object, and object in heap. More... | |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Detailed Description
CEvent - generic event implementation TODO TODO - Attachments.
The documentation for this class was generated from the following files:
