[Previous] [Contents] [Index] [Next]

RtProgress

A realtime progress bar

Class hierarchy:

PtWidget --> PtBasic --> PtGauge --> RtProgress

For more information, see the diagram of the widget hierarchy.

PhAB icon:

RtProgress button in PhAB

Public header:

<photon/realtime/RtProgress.h>

Description:

The RtProgress widget draws a progress bar and (optionally) the corresponding value in front of it.


RtProgress


An RtProgress bar.


The bar can be either a single bar, growing continuously as the value is changed, or it can consist of a number of divisions of equal size.

New resources:

Resource C type Pt type Default
Rt_ARG_PROGRESS_BAR_COLOR PgColor_t Scalar Pg_RED
Rt_ARG_PROGRESS_DIVISIONS unsigned short Scalar 1
Rt_ARG_PROGRESS_GAP unsigned short Scalar 4
Rt_ARG_PROGRESS_SPACING unsigned short Scalar 0

Rt_ARG_PROGRESS_BAR_COLOR

C type Pt type Default
PgColor_t Scalar Pg_RED

The color of the progress bar.

Rt_ARG_PROGRESS_DIVISIONS

C type Pt type Default
unsigned short Scalar 1

The number of divisions (1 means continuous).

Rt_ARG_PROGRESS_GAP

C type Pt type Default
unsigned short Scalar 4

The gap (in pixels) between the progress bar and the text (if the text isn't on top of the bar).

Rt_ARG_PROGRESS_SPACING

C type Pt type Default
unsigned short Scalar 0

The spacing (in pixels) between divisions (see Rt_ARG_PROGRESS_DIVISIONS).

Inherited resources:

If the widget modifies an inherited resource, the "Default override" column indicates the new value. This modification affects any subclasses of the widget.

Resource Inherited from Default override
Pt_ARG_AREA PtWidget
Pt_ARG_BANDWIDTH_THRESHOLD PtBasic Not used by this class.
Pt_ARG_BITMAP_CURSOR PtWidget
Pt_ARG_BORDER_WIDTH PtWidget
Pt_ARG_BOT_BORDER_COLOR PtBasic
Pt_ARG_COLOR PtBasic Pg_BLACK
Pt_ARG_CURSOR_COLOR PtWidget
Pt_ARG_CURSOR_TYPE PtWidget
Pt_ARG_DATA PtWidget
Pt_ARG_DIM PtWidget
Pt_ARG_EFLAGS PtWidget
Pt_ARG_FILL_COLOR PtBasic Pg_GRAY
Pt_ARG_FILL_PATTERN PtBasic
Pt_ARG_FLAGS PtWidget
Pt_ARG_GAUGE_FLAGS PtGauge
Pt_ARG_GAUGE_FONT PtGauge
Pt_ARG_GAUGE_H_ALIGN PtGauge
Pt_ARG_GAUGE_MAXIMUM PtGauge
Pt_ARG_GAUGE_MINIMUM PtGauge
Pt_ARG_GAUGE_ORIENTATION PtGauge
Pt_ARG_GAUGE_V_ALIGN PtGauge
Pt_ARG_GAUGE_VALUE PtGauge
Pt_ARG_GAUGE_VALUE_PREFIX PtGauge
Pt_ARG_GAUGE_VALUE_SUFFIX PtGauge
Pt_ARG_HELP_TOPIC PtWidget
Pt_ARG_HIGHLIGHT_ROUNDNESS PtBasic
Pt_ARG_MARGIN_HEIGHT PtBasic
Pt_ARG_MARGIN_WIDTH PtBasic
Pt_ARG_POS PtWidget
Pt_ARG_RESIZE_FLAGS PtWidget Pt_RESIZE_XY_AS_REQUIRED
Pt_ARG_TOP_BORDER_COLOR PtBasic
Pt_ARG_TRANS_PATTERN PtBasic
Pt_ARG_USER_DATA PtWidget
Pt_CB_ACTIVATE PtBasic
Pt_CB_ARM PtBasic
Pt_CB_BLOCKED PtWidget
Pt_CB_DESTROYED PtWidget
Pt_CB_DISARM PtBasic
Pt_CB_GOT_FOCUS PtBasic
Pt_CB_HOTKEY PtWidget
Pt_CB_LOST_FOCUS PtBasic
Pt_CB_MENU PtBasic
Pt_CB_RAW PtWidget
Pt_CB_REALIZED PtWidget
Pt_CB_REPEAT PtBasic
Pt_CB_UNREALIZED PtWidget

[Previous] [Contents] [Index] [Next]