tbx  0.7.5
Public Member Functions | Friends | List of all members
tbx::IdBlock Class Reference

Information passed back by the Toolbox with each toolbox event providing information on where the event occurred. More...

#include <pollinfo.h>

Public Member Functions

 IdBlock ()
 Construct uninitialised IdBlock.
 
 IdBlock (Object obj)
 Construct IdBlock with details from the given object.
 
Object self_object () const
 Get the object the event occured on.
 
Component self_component () const
 Get the component the event occured on. More...
 
Object parent_object () const
 Get the parent object of the object the event occured upon. More...
 
Component parent_component () const
 Get the parent component of the object the event occured on. More...
 
Object ancestor_object () const
 Get the ancestor object of the object the event occured upon. More...
 
Component ancestor_component () const
 Get the ancestor component of the object the event occured on. More...
 

Friends

class EventRouter
 

Detailed Description

Information passed back by the Toolbox with each toolbox event providing information on where the event occurred.

Member Function Documentation

◆ ancestor_component()

Component IdBlock::ancestor_component ( ) const

Get the ancestor component of the object the event occured on.

The returned component will be null if the event did not occur on a component.

◆ ancestor_object()

Object IdBlock::ancestor_object ( ) const

Get the ancestor object of the object the event occured upon.

The object will be null if there was no parent object.

◆ parent_component()

Component IdBlock::parent_component ( ) const

Get the parent component of the object the event occured on.

The returned component will be null if the event did not occur on a component.

◆ parent_object()

Object IdBlock::parent_object ( ) const

Get the parent object of the object the event occured upon.

The object will be null if there was no parent object.

◆ self_component()

Component IdBlock::self_component ( ) const

Get the component the event occured on.

The returned component will be null if the event did not occur on a component.


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