te::qt::widgets::CreateProgressWidgetItemEvent Class Reference

The CreateProgressWidgetItemEvent is a custom event used to create a progress widget item. More...

#include <CreateProgressWidgetItemEvent.h>

Inheritance diagram for te::qt::widgets::CreateProgressWidgetItemEvent:

Public Member Functions

 CreateProgressWidgetItemEvent (const QString &label, int taskId, int totalSteps)
 It initializes a new CreateProgressWidgetItemEvent. More...
 
 ~CreateProgressWidgetItemEvent ()
 Destructor. More...
 

Static Public Member Functions

static QEvent::Type type ()
 Get the custom event type. More...
 

Public Attributes

QString m_label
 Progress widget item label. More...
 
int m_taskId
 The task id associated with the progress widget that will be created. More...
 
int m_totalSteps
 The total steps of progress widget that will be created. More...
 

Static Private Attributes

static QEvent::Type sm_customEventType
 Custom Event Type. More...
 

Detailed Description

The CreateProgressWidgetItemEvent is a custom event used to create a progress widget item.

This event can be used when working with multithread tasks.

Definition at line 49 of file CreateProgressWidgetItemEvent.h.

Constructor & Destructor Documentation

te::qt::widgets::CreateProgressWidgetItemEvent::CreateProgressWidgetItemEvent ( const QString &  label,
int  taskId,
int  totalSteps 
)

It initializes a new CreateProgressWidgetItemEvent.

Parameters
labelProgress widget item label.
taskIdThe task id associated with the progress widget that will be created.
totalStepsThe total steps of progress widget that will be created.
Note
If the totalSteps equals 0 the progress widget shows a busy indicator instead of a percentage of steps.
te::qt::widgets::CreateProgressWidgetItemEvent::~CreateProgressWidgetItemEvent ( )

Destructor.

Member Function Documentation

static QEvent::Type te::qt::widgets::CreateProgressWidgetItemEvent::type ( )
static

Get the custom event type.

Member Data Documentation

QString te::qt::widgets::CreateProgressWidgetItemEvent::m_label

Progress widget item label.

Definition at line 72 of file CreateProgressWidgetItemEvent.h.

int te::qt::widgets::CreateProgressWidgetItemEvent::m_taskId

The task id associated with the progress widget that will be created.

Definition at line 73 of file CreateProgressWidgetItemEvent.h.

int te::qt::widgets::CreateProgressWidgetItemEvent::m_totalSteps

The total steps of progress widget that will be created.

Definition at line 74 of file CreateProgressWidgetItemEvent.h.

QEvent::Type te::qt::widgets::CreateProgressWidgetItemEvent::sm_customEventType
staticprivate

Custom Event Type.

Definition at line 78 of file CreateProgressWidgetItemEvent.h.


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