tbx  0.7.3
Public Types | Public Member Functions | List of all members
tbx::AboutToBeShownEvent Class Reference

Event information for AboutToBeShown event. More...

#include <abouttobeshownlistener.h>

Inheritance diagram for tbx::AboutToBeShownEvent:
tbx::EventInfo

Public Types

enum  ShowType { SHOW_DEFAULT = 0, SHOW_FULL_SPEC = 1, SHOW_TOP_LEFT = 2 }
 How the object has been shown.
 

Public Member Functions

 AboutToBeShownEvent (IdBlock &id_block, PollBlock &data)
 Construct from information returned from the toolbox poll. More...
 
ShowType show_type () const
 Return how the object has been shown.
 
Pointtop_left () const
 Return the top left coordinate where the object will be shown.
 
Pointtop_left ()
 Return a reference to the top left coordinate.
 
ShowFullSpecfull_spec ()
 Return a reference to the Full specification of where the object has been shown. More...
 
- Public Member Functions inherited from tbx::EventInfo
 EventInfo (const IdBlock &id_block, PollBlock &data)
 Contruct the event information from the id_block and data update by the toolbox.
 
const IdBlockid_block () const
 IdBlock for the current event. More...
 

Additional Inherited Members

- Protected Attributes inherited from tbx::EventInfo
PollBlock_data
 raw data from the event
 

Detailed Description

Event information for AboutToBeShown event.

Constructor & Destructor Documentation

tbx::AboutToBeShownEvent::AboutToBeShownEvent ( IdBlock id_block,
PollBlock data 
)
inline

Construct from information returned from the toolbox poll.

Parameters
id_blockblock containing relevant object/component ids
datadata for the event that raised the event.

Member Function Documentation

ShowFullSpec& tbx::AboutToBeShownEvent::full_spec ( )
inline

Return a reference to the Full specification of where the object has been shown.

show_type() must be SHOW_FULL_SPEC for this to be valid.


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