swift
Public Member Functions | List of all members
XSwiftBus::CMessageBoxControl Class Reference

Class which builds upon CMessageBox with a scrollback buffer and commands for user control. More...

Public Member Functions

 CMessageBoxControl (int left, int right, int top)
 Constructor. More...
 
void addMessage (const CMessage &message)
 Add a new message to the bottom of the list.
 
int maxLineLength () const
 Returns the maximum number of characters per line. More...
 
void setValues (int leftPx, int topPx, int rightPx, int bottomPx, int lines, int durationMs)
 Set margin values. More...
 
void setMaxVisibleLines (size_t lines)
 Set max. visible lines.
 
void toggle ()
 Toggles the visibility of the message box.
 
bool isVisible () const
 Is message box currently visible?
 

Detailed Description

Class which builds upon CMessageBox with a scrollback buffer and commands for user control.

Definition at line 110 of file messages.h.

Constructor & Destructor Documentation

◆ CMessageBoxControl()

XSwiftBus::CMessageBoxControl::CMessageBoxControl ( int  left,
int  right,
int  top 
)

Constructor.

Parameters
leftNumber of "virtual pixels" between screen left edge and box left edge.
rightNumber of "virtual pixels" between screen right edge and box right edge.
topNumber of "virtual pixels" between screen top edge and box top edge.

Member Function Documentation

◆ maxLineLength()

int XSwiftBus::CMessageBoxControl::maxLineLength ( ) const
inline

Returns the maximum number of characters per line.

Definition at line 120 of file messages.h.

◆ setValues()

void XSwiftBus::CMessageBoxControl::setValues ( int  leftPx,
int  topPx,
int  rightPx,
int  bottomPx,
int  lines,
int  durationMs 
)
inline

Set margin values.

Definition at line 123 of file messages.h.


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