ATTPCROOT  0.3.0-alpha
A ROOT-based framework for analyzing data from active target detectors
Public Member Functions | Protected Attributes | List of all members
AtSidebarAddon Class Reference

#include <AtSidebarAddon.h>

Inheritance diagram for AtSidebarAddon:
Inheritance graph
[legend]
Collaboration diagram for AtSidebarAddon:
Collaboration graph
[legend]

Public Member Functions

 AtSidebarAddon (const TGWindow *p=nullptr, UInt_t w=1, UInt_t h=1, UInt_t options=0, Pixel_t back=GetDefaultFrameBackground())
 
void AddInfoBox (std::string label)
 
void AddIntBox (std::string label, std::string function, int min=0, int max=1)
 
TString GetInfoString (std::string label)
 
Long_t GetIntNumber (std::string label)
 
void SetInfoString (std::string label, TString value)
 
void SetIntNumber (std::string label, Long_t value)
 
void FillFrame () override
 
 ClassDefOverride (AtSidebarAddon, 1)
 
- Public Member Functions inherited from AtVerticalSidebarFrame
 AtVerticalSidebarFrame (const TGWindow *p=nullptr, UInt_t w=1, UInt_t h=1, UInt_t options=0, Pixel_t back=GetDefaultFrameBackground())
 
- Public Member Functions inherited from AtSidebarFrame
void UsePictureButtons (bool val=true)
 Use text only buttons instead of picture buttons. More...
 

Protected Attributes

std::map< std::string, TGNumberEntry * > fNumbers
 
std::map< std::string, TGLabel * > fStrings
 
- Protected Attributes inherited from AtSidebarFrame
bool kUsePictureButtons {false}
 Option to disable picture buttons since they break some machines. More...
 

Additional Inherited Members

- Protected Member Functions inherited from AtSidebarFrame
 AtSidebarFrame (const TGWindow *p=nullptr, UInt_t w=1, UInt_t h=1, UInt_t options=0, Pixel_t back=GetDefaultFrameBackground())
 

Detailed Description

A base class for creating addons to the Event Viewer. Contains functions for adding different types of sidebar items. See AtSidebarPSA for an example of the implementation.

Definition at line 24 of file AtSidebarAddon.h.

Constructor & Destructor Documentation

◆ AtSidebarAddon()

AtSidebarAddon::AtSidebarAddon ( const TGWindow *  p = nullptr,
UInt_t  w = 1,
UInt_t  h = 1,
UInt_t  options = 0,
Pixel_t  back = GetDefaultFrameBackground() 
)
inline

Definition at line 30 of file AtSidebarAddon.h.

Member Function Documentation

◆ AddInfoBox()

void AtSidebarAddon::AddInfoBox ( std::string  label)

Adds a text box for an string that updates with SetInfoString. label is used as the title for the text box and to index the string stored by the text box.

Definition at line 18 of file AtSidebarAddon.cxx.

◆ AddIntBox()

void AtSidebarAddon::AddIntBox ( std::string  label,
std::string  function,
int  min = 0,
int  max = 1 
)

Adds a text box for an itneger that triggers a function defined in the derived class. label is used as the title for the text box and to index the number stored by the text box. min and max are inlclusive bounds.

Definition at line 34 of file AtSidebarAddon.cxx.

◆ ClassDefOverride()

AtSidebarAddon::ClassDefOverride ( AtSidebarAddon  ,
 
)

◆ FillFrame()

void AtSidebarAddon::FillFrame ( )
inlineoverridevirtual

Called at the end of the Init stage. Is what will create all of the components in the sidebar frame.

Implements AtSidebarFrame.

Reimplemented in AtSidebarInfoMacro, AtSidebarPSA, AtSidebarPSADeconv, AtSidebarPSATBAvg, and AtSidebarPSAIterDeconv.

Definition at line 69 of file AtSidebarAddon.h.

◆ GetInfoString()

TString AtSidebarAddon::GetInfoString ( std::string  label)

Get the string managed by an AddInfoBox indexed by label.

Definition at line 54 of file AtSidebarAddon.cxx.

◆ GetIntNumber()

Long_t AtSidebarAddon::GetIntNumber ( std::string  label)

Get the integer managed by an AddIntBox indexed by label.

Definition at line 63 of file AtSidebarAddon.cxx.

◆ SetInfoString()

void AtSidebarAddon::SetInfoString ( std::string  label,
TString  value 
)

Set the string managed by an AddInfoBox indexed by label.

Definition at line 72 of file AtSidebarAddon.cxx.

◆ SetIntNumber()

void AtSidebarAddon::SetIntNumber ( std::string  label,
Long_t  value 
)

Set the integer managed by an AddIntBox indexed by label.

Definition at line 82 of file AtSidebarAddon.cxx.

Member Data Documentation

◆ fNumbers

std::map<std::string, TGNumberEntry *> AtSidebarAddon::fNumbers
protected

Definition at line 26 of file AtSidebarAddon.h.

◆ fStrings

std::map<std::string, TGLabel *> AtSidebarAddon::fStrings
protected

Definition at line 27 of file AtSidebarAddon.h.


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