Documents > BPS V2 C++ API
BpsTextLogWidget Class Reference

A widget to display text logging information. More...

#include <bpstextlogwidget.h>

List of all members.

Public Member Functions

 BpsTextLogWidget (QWidget *aParent=0)
int limit () const
void logBinary (const QString &aText, const QColor &aColor=Qt::black)
 Write text as single log line, where all special and unprintable characters are displayed in human readable format.
void logText (const QString &aText, const QColor &aColor=Qt::black)
 Write text to the log.
void setLimit (int aLines)
 Set the maximum number of lines to hold in the log.
QString text () const

Detailed Description

A widget to display text logging information.


Constructor & Destructor Documentation

BpsTextLogWidget::BpsTextLogWidget ( QWidget *  aParent = 0)
Parameters:
[in]aParentThe parent widget.

Member Function Documentation

int BpsTextLogWidget::limit ( ) const
Returns:
The maximum number of lines to hold in the log. The default is 0.
void BpsTextLogWidget::logBinary ( const QString &  aText,
const QColor &  aColor = Qt::black 
)

Write text as single log line, where all special and unprintable characters are displayed in human readable format.

Control-characters like LF for example appear as [LF] in inverse colors. Unprintable characters are displayed as hex value and appear for example as <FE> in inverse color.

Parameters:
[in]aTextThe text to log.
[in]aColorThe foreground color to use.
void BpsTextLogWidget::logText ( const QString &  aText,
const QColor &  aColor = Qt::black 
)

Write text to the log.

Newlines force a line break, all other special or unprintable characters are replaced by a blank.

Parameters:
[in]aTextThe text to log.
[in]aColorThe foreground color to use.
void BpsTextLogWidget::setLimit ( int  aLines)

Set the maximum number of lines to hold in the log.

A value <= 0 means no limit.

Parameters:
[in]aLinesThe maximum lines to log.
QString BpsTextLogWidget::text ( ) const
Returns:
The plain text of the log. The only unprintable characters contained are linefeeds (LF) to separate the log lines.

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