FreeBSD Manual Pages
AG_PROGRESS_BAR(3) Library Functions Manual AG_PROGRESS_BAR(3) NAME AG_ProgressBar -- agar progress bar widget SYNOPSIS #include <agar/core.h> #include <agar/gui.h> DESCRIPTION The AG_ProgressBar widget binds to minimum, maximum and value integers and displays a progress bar representing the value. INHERITANCE HIERARCHY AG_Object(3) -> AG_Widget(3) -> AG_ProgressBar. INITIALIZATION AG_ProgressBar * AG_ProgressBarNew(AG_Widget *parent, enum ag_progress_bar_type type, Uint flags) AG_ProgressBar * AG_ProgressBarNewInt(AG_Widget *parent, enum ag_progress_bar_type type, Uint flags, int *value, int *min, int *max) AG_ProgressBar * AG_ProgressBarNewHoriz(AG_Widget *parent, Uint flags) AG_ProgressBar * AG_ProgressBarNewVert(AG_Widget *parent, Uint flags) void AG_ProgressBarSetWidth(AG_ProgressBar *pb, int width) void AG_ProgressBarSetLength(AG_ProgressBar *pb, int length) int AG_ProgressBarPercent(AG_ProgressBar *pb) The AG_ProgressBarNew() function allocates, initializes, and attaches a new AG_ProgressBar widget. type defines the style: enum ag_progress_bar_type { AG_PROGRESS_BAR_HORIZ, AG_PROGRESS_BAR_VERT }; Acceptable flags include: AG_PROGRESS_BAR_SHOW_PCT Display text showing the percentage. AG_PROGRESS_BAR_EXCL Advise that no external changes to the value, min and max bindings are expected. By default, the binding values are periodi- cally checked and the progress bar is re- drawn if a change is detected. AG_PROGRESS_BAR_HFILL Expand horizontally in parent container. AG_PROGRESS_BAR_VFILL Expand vertically in parent container. AG_PROGRESS_BAR_EXPAND Shorthand for AG_PROGRESS_BAR_HFILL | AG_PROGRESS_BAR_VFILL. The AG_ProgressBarNewInt() variant binds the `value', `min' and `max' bindings on initialization. The AG_ProgressBarNewHoriz() and AG_ProgressBarNewVert() variants spec- ify the layout on initialization. The AG_ProgressBarSetWidth() function sets the width of the bar in pix- els. AG_ProgressBarSetLength() requests a preferred length in pixels. Al- ternatively, AG_PROGRESS_BAR_HFILL or AG_PROGRESS_BAR_VFILL may be used. The AG_ProgressBarPercent() returns the percentage for the currently bound value and range. BINDINGS The AG_ProgressBar widget provides the following bindings: int *value Current value int *min Minimum value int *max Maximum value EVENTS The AG_ProgressBar widget does not generate any event. SEE ALSO AG_Intro(3), AG_Numerical(3), AG_Scrollbar(3), AG_Widget(3), AG_Window(3) HISTORY The AG_ProgressBar widget first appeared in Agar 1.3.4. Agar 1.7 December 21, 2022 AG_PROGRESS_BAR(3)
NAME | SYNOPSIS | DESCRIPTION | INHERITANCE HIERARCHY | INITIALIZATION | BINDINGS | EVENTS | SEE ALSO | HISTORY
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=AG_ProgressBar&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>