TalanSoft Toolkits  201707
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
iSinkList Struct Referenceabstract
Inheritance diagram for iSinkList:
iCollection iUnknown

Detailed Description

Sink list interface.

Public Member Functions

virtual const tUUIDGetSinkUUID () const =0
 Get the UUID of the sink. {Property}. More...
 
virtual void Clear ()=0
 Remove all the sinks. More...
 
virtual tBool HasSink (iUnknown *apSink)=0
 Check whether the specified sink has already been added. More...
 
virtual tBool AddSink (iUnknown *apSink)=0
 Add a sink to the sink list. More...
 
virtual tBool RemoveSink (iUnknown *apSink)=0
 Remove a sink from the sink list. More...
 
virtual tBool AddFrontSink (iUnknown *apSink)=0
 Add a sink to the front of the sink list. More...
 
virtual void SetMute (tBool abMute)=0
 Mute the sink. {Property}. More...
 
virtual tBool GetMute () const =0
 Get the muted status of the sink. {Property}. More...
 
- Public Member Functions inherited from iCollection
virtual tType GetKeyType () const =0
 Get the collection's key type. {Property}. More...
 
virtual tType GetValueType () const =0
 Get the collection's value type. {Property}. More...
 
virtual tBool IsEmpty () const =0
 Returns true if this collection contains no elements. More...
 
virtual tU32 GetSize () const =0
 Returns the number of elements in this collection. More...
 
virtual tBool Contains (const Var &aVar) const =0
 Returns true if this collection contains the specified key. More...
 
virtual tBool ContainsAll (const iCollection *apCollection) const =0
 Returns true if this collection contains all of the elements in the specified collection. More...
 
virtual iIteratorIterator () const =0
 Returns an iterator over the elements in this collection. More...
 
virtual iIteratorFind (const Var &aVar) const =0
 Returns an iterator over starting at the specified elements in this collection. More...
 
virtual Var Get (const Var &aKey) const =0
 Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key. More...
 
virtual Var GetFirst () const =0
 Returns the first value in the container. {Property}. More...
 
virtual Var GetLast () const =0
 Returns the last value in the container. {Property}. More...
 
- Public Member Functions inherited from iUnknown
virtual tBool IsOK () const =0
 Check if the object is valid. More...
 
virtual tI32 AddRef ()=0
 Signal that one more reference of the object has been created. More...
 
virtual tI32 Release ()=0
 Release a reference of the object. More...
 
virtual void DeleteThis ()=0
 Bypass any reference counting and delete this object. More...
 
virtual void Invalidate ()=0
 Invalidate the object. More...
 
virtual iUnknownQueryInterface (const tUUID &aIID)=0
 Query an interface. More...
 
virtual void ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
 Fill a UUID list containing the UUIDs of the implemented interfaces. More...
 
virtual tI32 SetNumRefs (tI32 anNumRefs)=0
 Set the reference counter directly. More...
 
virtual tI32 GetNumRefs () const =0
 Get the number of references to this object. More...
 

Member Function Documentation

virtual const tUUID& GetSinkUUID ( ) const
pure virtual

Get the UUID of the sink. {Property}.

virtual void Clear ( )
pure virtual

Remove all the sinks.

virtual tBool HasSink ( iUnknown apSink)
pure virtual

Check whether the specified sink has already been added.

virtual tBool AddSink ( iUnknown apSink)
pure virtual

Add a sink to the sink list.

virtual tBool RemoveSink ( iUnknown apSink)
pure virtual

Remove a sink from the sink list.

virtual tBool AddFrontSink ( iUnknown apSink)
pure virtual

Add a sink to the front of the sink list.

virtual void SetMute ( tBool  abMute)
pure virtual

Mute the sink. {Property}.

virtual tBool GetMute ( ) const
pure virtual

Get the muted status of the sink. {Property}.