tbx  0.7.5
Public Types | Public Member Functions | List of all members
tbx::PrintDboxSetupAboutToBeShownEvent Class Reference

The dialog box associated with the setup button is about to be shown event. More...

#include <printdbox.h>

Inheritance diagram for tbx::PrintDboxSetupAboutToBeShownEvent:
tbx::EventInfo

Public Types

enum  ShowType { SHOW_DEFAULT = 0, SHOW_FULL_SPEC = 1, SHOW_TOP_LEFT = 2 }
 Enumeration describing how the setup box is about to be shown. More...
 

Public Member Functions

 PrintDboxSetupAboutToBeShownEvent (IdBlock &id_block, PollBlock &data)
 Construct setup about to be shown event from Toolbox and WIMP information. More...
 
Window setup_window () const
 Setup window that is about to be shown.
 
ShowType show_type () const
 Get how the setup windows was shown. More...
 
Pointtop_left () const
 Get top left coordinate of where the window will be shown. More...
 
Pointtop_left ()
 Get reference to top left coordinate so it can be changed in the event. More...
 
ShowFullSpecfull_spec ()
 Get reference to the full specification for the show so it can be modified. 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

The dialog box associated with the setup button is about to be shown event.

Member Enumeration Documentation

◆ ShowType

Enumeration describing how the setup box is about to be shown.

Enumerator
SHOW_DEFAULT 

Shown in default place.

SHOW_FULL_SPEC 

Full details of window used.

Constructor & Destructor Documentation

◆ PrintDboxSetupAboutToBeShownEvent()

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

Construct setup about to be shown event from Toolbox and WIMP information.

Parameters
id_blockToolbox information
dataWIMP event information

Member Function Documentation

◆ full_spec()

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

Get reference to the full specification for the show so it can be modified.

Returns
reference to the full show specification

◆ show_type()

ShowType tbx::PrintDboxSetupAboutToBeShownEvent::show_type ( ) const
inline

Get how the setup windows was shown.

Returns
show type enumeration value

◆ top_left() [1/2]

Point& tbx::PrintDboxSetupAboutToBeShownEvent::top_left ( ) const
inline

Get top left coordinate of where the window will be shown.

Returns
top left window coordinate

◆ top_left() [2/2]

Point& tbx::PrintDboxSetupAboutToBeShownEvent::top_left ( )
inline

Get reference to top left coordinate so it can be changed in the event.

Returns
Point reference to coordinate to allow it to be changed

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