progressbar.h File Reference

Progress bar widget constructor and methods. More...

#include "../types/progressbar.h"

Go to the source code of this file.

Functions
ui_progressbar_t *	CreateProgress (unsigned short tag, short x, short y, short width, short height, unsigned short maximum, unsigned short segment_count, unsigned short flags)
	Create a progress bar widget.
void	PPROGRESSetPos (ui_progressbar_t *self, unsigned short position)
	Set the progress bar position.
unsigned short	PPROGRESSetRange (ui_progressbar_t *self, unsigned short maximum)
	Change the maximum position of the progress bar and refreshes the view.

Detailed Description

Progress bar widget constructor and methods.

Function Documentation

CreateProgress()

ui_progressbar_t * CreateProgress ( unsigned short tag, short x, short y, short width, short height, unsigned short maximum, unsigned short segment_count, unsigned short flags )

extern

Create a progress bar widget.

Syscall Number

0x10158

Parameters

tag	Component tag. Can be used to distinguish components under some circumstances (like when sharing a callback with another component, or looking up an item with GetDeskItem()). Does not need to be unique. Usually will be set by AllocBlock() after the memory was allocated.
x	X coordinate of the top-left corner, in pixels (inclusive).
y	Y coordinate of the top-left corner, in pixels (inclusive).
width	Width of the progress bar.
height	Height of the progress bar.
maximum	Maximum position value of the progress bar.
segment_count	Segment count if the progress bar is in segmented mode.
flags	Style flags.

Returns

The created progress bar widget object.

See also

ui_progressbar_flags_e

PPROGRESSetPos()

void PPROGRESSetPos ( ui_progressbar_t * self, unsigned short position )

extern

Set the progress bar position.

Note

New values above maximum are rejected rather than clamped.

Syscall Number

0x1015a

Parameters

self	The progress bar object.
position	New position value.

Returns

None.

PPROGRESSetRange()

unsigned short PPROGRESSetRange ( ui_progressbar_t * self, unsigned short maximum )

extern

Change the maximum position of the progress bar and refreshes the view.

Syscall Number

0x1015b

Parameters

self	The progress bar object.
maximum	The new maximum position value.

Returns

The old maximum position value.