def fl_set_slider_increment(ptr_flobject, leftbtnval, midbtnval):
"""fl_set_slider_increment(ptr_flobject, leftbtnval, midbtnval)
Defines slider increments for clicks with left and middle mouse button.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
slider flobject
leftbtnval : float
value to increment if the left mouse button is pressed
midbtnval : float
value to increment if the middle mouse button is pressed
Examples
--------
>>> *todo*
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_slider_increment = library.cfuncproto(
library.load_so_libforms(), "fl_set_slider_increment",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double, cty.c_double],
"""void fl_set_slider_increment(FL_OBJECT * ob, double l,
double r)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_leftbtnval = library.convert_to_doublec(leftbtnval)
f_midbtnval = library.convert_to_doublec(midbtnval)
library.keep_elem_refs(ptr_flobject, leftbtnval, midbtnval, \
f_leftbtnval, f_midbtnval)
_fl_set_slider_increment(ptr_flobject, f_leftbtnval, f_midbtnval)
def fl_set_counter_step(ptr_flobject, smallsize, largesize):
"""fl_set_counter_step(ptr_flobject, smallsize, largesize)
Defines the sizes of the small and large steps of a counter. For simple
counters only the small step is used.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
counter flobject
smallsize : float
small step's size. By default it is 0.1.
largesize : float
large step's size. By default it is 1.
Examples
--------
>>> fl_set_counter_step(pcntrobj, 0.2, 2)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_counter_step = library.cfuncproto(
library.load_so_libforms(), "fl_set_counter_step",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double, cty.c_double],
"""void fl_set_counter_step(FL_OBJECT * ob, double s, double l)""")
library.verify_flobjectptr_type(ptr_flobject)
f_smallsize = library.convert_to_doublec(smallsize)
f_largesize = library.convert_to_doublec(largesize)
library.keep_elem_refs(ptr_flobject, smallsize, largesize, f_smallsize,
f_largesize)
_fl_set_counter_step(ptr_flobject, f_smallsize, f_largesize)
def fl_set_spinner_bounds(ptr_flobject, minbound, maxbound):
"""fl_set_spinner_bounds(ptr_flobject, minbound, maxbound)
Defines minimum and maximum value limits of a spinner flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
spinner flobject
minbound : float
minimum value bound to be set
maxbound : float
maximum value bound to be set
Examples
--------
>>> fl_set_spinner_bounds(pspnobj, 1.0, 10.0)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_spinner_bounds = library.cfuncproto(
library.load_so_libforms(), "fl_set_spinner_bounds",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double, cty.c_double],
"""void fl_set_spinner_bounds(FL_OBJECT * obj, double min,
double max)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_minbound = library.convert_to_doublec(minbound)
f_maxbound = library.convert_to_doublec(maxbound)
library.keep_elem_refs(ptr_flobject, minbound, maxbound, \
f_minbound, f_maxbound)
_fl_set_spinner_bounds(ptr_flobject, f_minbound, f_maxbound)
def fl_set_counter_value(ptr_flobject, val):
"""fl_set_counter_value(ptr_flobject, val)
Defines the value of the counter flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
counter flobject
val : float
value to be set. By default it is 0.
Examples
--------
>>> fl_set_counter_value(pcntrobj, 42.0)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_counter_value = library.cfuncproto(
library.load_so_libforms(), "fl_set_counter_value",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double],
"""void fl_set_counter_value(FL_OBJECT * ob, double val)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_val = library.convert_to_doublec(val)
library.keep_elem_refs(ptr_flobject, val, f_val)
_fl_set_counter_value(ptr_flobject, f_val)
def fl_set_spinner_step(ptr_flobject, step):
"""fl_set_spinner_step(ptr_flobject, step)
Defines step that spinner values are rounded to.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
spinner flobject
step : float
step value to round spinner values to
Examples
--------
>>> fl_set_spinner_step(pspnobj, 0.5)
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_set_spinner_step = library.cfuncproto(
library.load_so_libforms(), "fl_set_spinner_step",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double],
"""void fl_set_spinner_step(FL_OBJECT * obj, double step)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_step = library.convert_to_doublec(step)
library.keep_elem_refs(ptr_flobject, step, f_step)
_fl_set_spinner_step(ptr_flobject, f_step)
def fl_set_scrollbar_value(ptr_flobject, scrvalue):
"""fl_set_scrollbar_value(ptr_flobject, scrvalue)
Defines the value of a scrollbar flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
scrollbar flobject
scrvalue : float
value of the scrollbar to be set. By default it is 0.5.
Examples
--------
>>> fl_set_scrollbar_value(pscrbobj, 0.75)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_scrollbar_value = library.cfuncproto(
library.load_so_libforms(), "fl_set_scrollbar_value",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double],
"""void fl_set_scrollbar_value(FL_OBJECT * ob, double val)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_scrvalue = library.convert_to_doublec(scrvalue)
library.keep_elem_refs(ptr_flobject, scrvalue, f_scrvalue)
_fl_set_scrollbar_value(ptr_flobject, f_scrvalue)
def fl_set_positioner_yvalue(ptr_flobject, yvalue):
"""fl_set_positioner_yvalue(ptr_flobject, yvalue)
Defines the actual value of positioner flobject in vertical direction.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
positioner flobject
yvalue : float
vertical value to be set. By default it is 0.5.
Examples
--------
>>> fl_set_positioner_yvalue(pstobj, 1.0)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_positioner_yvalue = library.cfuncproto(
library.load_so_libforms(), "fl_set_positioner_yvalue",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double],
"""void fl_set_positioner_yvalue(FL_OBJECT * ob, double val)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_yvalue = library.convert_to_doublec(yvalue)
library.keep_elem_refs(ptr_flobject, yvalue, f_yvalue)
_fl_set_positioner_yvalue(ptr_flobject, f_yvalue)
def fl_set_scrollbar_size(ptr_flobject, barsize):
"""fl_set_scrollbar_size(ptr_flobject, barsize)
Controls the size of the sliding bar inside the box. This function does
nothing if applied to scrollbars of type xfdata.FL_NICE_SCROLLBAR.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
scrollbar flobject
barsize : float
size of bar. Values between 0.0 and 1.0. The default is
xfdata.FL_SLIDER_WIDTH (which is 0.15 for all scrollbars). If it
is 1.0, the scrollbar covers the box completely and can no longer
be moved.
Examples
--------
>>> fl_set_scrollbar_size(pscrbobj, 0.2)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_scrollbar_size = library.cfuncproto(
library.load_so_libforms(), "fl_set_scrollbar_size",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double],
"""void fl_set_scrollbar_size(FL_OBJECT * ob, double val)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_barsize = library.convert_to_doublec(barsize)
library.keep_elem_refs(ptr_flobject, barsize, f_barsize)
_fl_set_scrollbar_size(ptr_flobject, f_barsize)
def fl_set_timer(ptr_flobject, tdelay):
"""fl_set_timer(ptr_flobject, tdelay)
Defines the timer to a particular value.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
timer flobject
tdelay : float
number of seconds the timer should run. If it is 0.0,
resets/de-blinks the timer.
Examples
--------
>>> fl_set_timer(ptimerobj, 20)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_timer = library.cfuncproto(
library.load_so_libforms(), "fl_set_timer",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double],
"""void fl_set_timer(FL_OBJECT * ob, double total)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_tdelay = library.convert_to_doublec(tdelay)
library.keep_elem_refs(ptr_flobject, tdelay, f_tdelay)
_fl_set_timer(ptr_flobject, f_tdelay)
def fl_set_slider_step(ptr_flobject, step):
"""fl_set_slider_step(ptr_flobject, step)
Defines the step size to which values are rounded in the
slider flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
slider flobject
step : float
step value
Examples
--------
>>> fl_set_slider_step(sldobj, 0.5)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_slider_step = library.cfuncproto(
library.load_so_libforms(), "fl_set_slider_step",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double],
"""void fl_set_slider_step(FL_OBJECT * ob, double value)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_step = library.convert_to_doublec(step)
library.keep_elem_refs(ptr_flobject, step, f_step)
_fl_set_slider_step(ptr_flobject, f_step)
def fl_set_spinner_value(ptr_flobject, spvalue):
"""fl_set_spinner_value(ptr_flobject, spvalue) -> oldspvalue
Defines value of a spinner flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
spinner flobject
spvalue : float
value to be set
Returns
-------
oldspvalue : float
previous spinner value
Examples
--------
>>> oldval = fl_set_spinner_value(spnobj, 12.0)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_spinner_value = library.cfuncproto(
library.load_so_libforms(), "fl_set_spinner_value",
cty.c_double, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double],
"""double fl_set_spinner_value(FL_OBJECT * obj, double val)""")
library.verify_flobjectptr_type(ptr_flobject)
f_spvalue = library.convert_to_doublec(spvalue)
library.keep_elem_refs(ptr_flobject, spvalue, f_spvalue)
_fl_set_spinner_value(ptr_flobject, f_spvalue)
def fl_set_slider_size(ptr_flobject, size):
"""fl_set_slider_size(ptr_flobject, size)
Defines the size of a slider flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
slider flobject
size : float
value of size of the slider
Examples
--------
>>> *todo*
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_slider_size = library.cfuncproto(
library.load_so_libforms(), "fl_set_slider_size",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double],
"""void fl_set_slider_size(FL_OBJECT * ob, double size)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_size = library.convert_to_doublec(size)
library.keep_elem_refs(ptr_flobject, size, f_size)
_fl_set_slider_size(ptr_flobject, f_size)
def fl_set_positioner_ystep(ptr_flobject, step):
"""fl_set_positioner_ystep(ptr_flobject, step)
Handles positioner values in vertical direction to be rounded to
some values (multiples of step), e.g. to integer values.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
positioner flobject
step : float
rounded value. If it is 0.0, switch off rounding.
Examples
--------
>>> fl_set_positioner_ystep(pstobj, 0.0)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_positioner_ystep = library.cfuncproto(
library.load_so_libforms(), "fl_set_positioner_ystep",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double],
"""void fl_set_positioner_ystep(FL_OBJECT * ob, double value)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_step = library.convert_to_doublec(step)
library.keep_elem_refs(ptr_flobject, step, f_step)
_fl_set_positioner_ystep(ptr_flobject, f_step)
def fl_set_scrollbar_bounds(ptr_flobject, minbound, maxbound):
"""fl_set_scrollbar_bounds(ptr_flobject, minbound, maxbound)
Defines the minimum and maximum value limits of a scrollbar flobject. For
vertical sliders the slider position for the minimum value is at the left,
for horizontal sliders at the top of the slider. By setting min to a
larger value than max in a call this can be reversed. When this function
is called, if the actual value of a scrollbar is not within the range of
the new bounds, its value gets adjusted to the nearest limit.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
scrollbar flobject
minbound : float
minimum value bound of scrollbar. By default, the minimum value
for a slider is 0.0.
maxbound : float
maximum value bound of scrollbar. By default, the maximum value
for a slider is 1.0.
Examples
--------
>>> fl_set_scrollbar_bounds(pscrbobj, 1.0, 2.0)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_scrollbar_bounds = library.cfuncproto(
library.load_so_libforms(), "fl_set_scrollbar_bounds",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double, cty.c_double],
"""void fl_set_scrollbar_bounds(FL_OBJECT * ob, double b1, double
b2)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_minbound = library.convert_to_doublec(minbound)
f_maxbound = library.convert_to_doublec(maxbound)
library.keep_elem_refs(ptr_flobject, minbound, maxbound, f_minbound, \
f_maxbound)
_fl_set_scrollbar_bounds(ptr_flobject, f_minbound, f_maxbound)
def fl_set_chart_bounds(ptr_flobject, minbound, maxbound):
"""fl_set_chart_bounds(ptr_flobject, minbound, maxbound)
Defines the boundaries/limits for values of a chart flobject. Normally,
bar-charts and line-charts are automatically scaled in the vertical
direction such that all values can be displayed.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
chart flobject
minbound : float
minimum value bounds to be set
maxbound : float
maximum value bounds to be set
Examples
--------
>>> fl_set_chart_bounds(pchrtobj, 100, 950)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_chart_bounds = library.cfuncproto(
library.load_so_libforms(), "fl_set_chart_bounds",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double, cty.c_double],
"""void fl_set_chart_bounds(FL_OBJECT * ob, double min,
double max)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_minbound = library.convert_to_doublec(minbound)
f_maxbound = library.convert_to_doublec(maxbound)
library.keep_elem_refs(ptr_flobject, minbound, maxbound, f_minbound, \
f_maxbound)
_fl_set_chart_bounds(ptr_flobject, f_minbound, f_maxbound)
def fl_set_scrollbar_increment(ptr_flobject, leftbtnval, midlbtnval):
"""fl_set_scrollbar_increment(ptr_flobject, leftbtnval, midlbtnval)
Defines the size of the steps of a scrollbar jump. By default, if the mouse
is pressed beside the the sliding bar, the bar starts to jumps in the
direction of the mouse position.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
scrollbar flobject
leftbtnval : float
value to increment if the left mouse button is pressed
midlbtnval : float
value to increment if the middle mouse button is pressed
Examples
--------
>>> *todo*
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_scrollbar_increment = library.cfuncproto(
library.load_so_libforms(), "fl_set_scrollbar_increment",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double, cty.c_double],
"""void fl_set_scrollbar_increment(FL_OBJECT * ob, double l,
double r)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_leftbtnval = library.convert_to_doublec(leftbtnval)
f_midlbtnval = library.convert_to_doublec(midlbtnval)
library.keep_elem_refs(ptr_flobject, leftbtnval, midlbtnval, \
f_leftbtnval, f_midlbtnval)
_fl_set_scrollbar_increment(ptr_flobject, f_leftbtnval, f_midlbtnval)
def fl_set_positioner_ybounds(ptr_flobject, minbound, maxbound):
"""fl_set_positioner_ybounds(ptr_flobject, minbound, maxbound)
Defines minimum and maximum bounds for values of a positioner in
vertical direction.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
positioner flobject
minbound : float
minimum value limit to be set. By default the minimum value is 0.0
maxbound : float
maximum value limit to be set. By default the maximum value is 1.0
Examples
--------
>>> fl_set_positioner_ybounds(pstobj, 0.5, 1.5)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_positioner_ybounds = library.cfuncproto(
library.load_so_libforms(), "fl_set_positioner_ybounds",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double, cty.c_double],
"""void fl_set_positioner_ybounds(FL_OBJECT * ob, double min,
double max)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_minbound = library.convert_to_doublec(minbound)
f_maxbound = library.convert_to_doublec(maxbound)
library.keep_elem_refs(ptr_flobject, minbound, maxbound, f_minbound,
f_maxbound)
_fl_set_positioner_ybounds(ptr_flobject, f_minbound, f_maxbound)
def fl_set_counter_bounds(ptr_flobject, minbound, maxbound):
"""fl_set_counter_bounds(ptr_flobject, minbound, maxbound)
Defines the minimum and maximum values that the counter will take.
For conflicting settings bound takes precedence over value.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
counter flobject
minbound : float
minimum value to be set. By default it is -1000000.
maxbound : float
maximum value to be set. By default it is 1000000.
Examples
--------
>>> fl_set_counter_bounds(pcntrobj, -100.0, 100.0)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_counter_bounds = library.cfuncproto(
library.load_so_libforms(), "fl_set_counter_bounds",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double, cty.c_double],
"""void fl_set_counter_bounds(FL_OBJECT * ob, double min,
double max)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_minbound = library.convert_to_doublec(minbound)
f_maxbound = library.convert_to_doublec(maxbound)
library.keep_elem_refs(ptr_flobject, minbound, maxbound, f_minbound, \
f_maxbound)
_fl_set_counter_bounds(ptr_flobject, f_minbound, f_maxbound)
def fl_insert_chart_value(ptr_flobject, indx, itemval, label, colr):
"""fl_insert_chart_value(ptr_flobject, indx, itemval, label, colr)
Inserts a new value at a particular place in a chart flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
chart flobject
indx : int
index before which the new item should be inserted. The first
item is number 1.
itemval : float
value of new chart item
label : str
text label of chart
colr : long_pos
XForms colormap index as color
Examples
--------
>>> fl_insert_chart_value(pchrtobj, 2, 123.0, "new value",
xfdata.FL_DEEPSKYBLUE)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_insert_chart_value = library.cfuncproto(
library.load_so_libforms(), "fl_insert_chart_value",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_int, cty.c_double,
xfdata.STRING, xfdata.FL_COLOR],
"""void fl_insert_chart_value(FL_OBJECT * ob, int indx,
double val, const char * str, FL_COLOR col)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
i_indx = library.convert_to_intc(indx)
f_itemval = library.convert_to_doublec(itemval)
s_label = library.convert_to_bytestrc(label)
ul_colr = library.convert_to_FL_COLOR(colr)
library.keep_elem_refs(ptr_flobject, indx, itemval, label, colr, \
i_indx, f_itemval, s_label, ul_colr)
_fl_insert_chart_value(ptr_flobject, i_indx, f_itemval, s_label, ul_colr)
def fl_replace_chart_value(ptr_flobject, indx, itemval, label, colr):
"""fl_replace_chart_value(ptr_flobject, indx, itemval, label, colr)
Replaces value of an item in the chart flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
chart flobject
indx : int
index position of item to be replaced. The first item is number 1
itemval : float
value of chart item
label : str
text label of chart
colr : long_pos
XForms colormap index as color
Examples
--------
>>> fl_replace_chart_value(pchrtobj, 3, 142.0, "replaced item",
xfdata.FL_FIREBRICK)
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_replace_chart_value = library.cfuncproto(
library.load_so_libforms(), "fl_replace_chart_value",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_int, cty.c_double,
xfdata.STRING, xfdata.FL_COLOR],
"""void fl_replace_chart_value(FL_OBJECT * ob, int indx,
double val, const char * str, FL_COLOR col)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
i_indx = library.convert_to_intc(indx)
f_itemval = library.convert_to_doublec(itemval)
s_label = library.convert_to_bytestrc(label)
ul_colr = library.convert_to_FL_COLOR(colr)
library.keep_elem_refs(ptr_flobject, indx, itemval, label, colr, \
i_indx, f_itemval, s_label, ul_colr)
_fl_replace_chart_value(ptr_flobject, i_indx, f_itemval, s_label, \
ul_colr)
def fl_add_chart_value(ptr_flobject, itemval, label, colr):
"""fl_add_chart_value(ptr_flobject, itemval, label, colr)
Adds an item to the chart flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
chart flobject
itemval : float
value of chart item
label : str
text label of chart
colr : long_pos
XForms colormap index as color
Examples
--------
>>> fl_add_chart_value(pchrtobj, 120, "Some point", xfdata.FL_BLUE)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_add_chart_value = library.cfuncproto(
library.load_so_libforms(), "fl_add_chart_value",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double, xfdata.STRING,
xfdata.FL_COLOR],
"""void fl_add_chart_value(FL_OBJECT * ob, double val,
const char * str, FL_COLOR col)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_itemval = library.convert_to_doublec(itemval)
s_label = library.convert_to_bytestrc(label)
ul_colr = library.convert_to_FL_COLOR(colr)
library.keep_elem_refs(ptr_flobject, itemval, label, colr, f_itemval, \
s_label, ul_colr)
_fl_add_chart_value(ptr_flobject, f_itemval, s_label, ul_colr)
def fl_set_thumbwheel_value(ptr_flobject, thwvalue):
"""fl_set_thumbwheel_value(ptr_flobject, thwvalue) -> oldthwvalue
Defines a new value of a thumbwheel flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
thumbwheel flobject
thwvalue : float
new value to be set
Returns
-------
oldthwvalue : float
previous value, or 1.0 (on failure)
Examples
--------
>>> oldval = fl_set_thumbwheel_value(pthwobj, 5.0)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_thumbwheel_value = library.cfuncproto(
library.load_so_libforms(), "fl_set_thumbwheel_value",
cty.c_double, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double],
"""double fl_set_thumbwheel_value(FL_OBJECT * ob, double value)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_thwvalue = library.convert_to_doublec(thwvalue)
library.keep_elem_refs(ptr_flobject, thwvalue, f_thwvalue)
retval = _fl_set_thumbwheel_value(ptr_flobject, f_thwvalue)
return retval
def fl_set_thumbwheel_step(ptr_flobject, step):
"""fl_set_thumbwheel_step(ptr_flobject, step) -> oldstep
Defines step for thumbwheel flobject value to be rounded to.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
thumbwheel flobject
step : float
step value to be set
Returns
-------
oldstep : float
previous step value
Examples
--------
>>> *todo*
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_thumbwheel_step = library.cfuncproto(
library.load_so_libforms(), "fl_set_thumbwheel_step",
cty.c_double, [cty.POINTER(xfdata.FL_OBJECT), cty.c_double],
"""double fl_set_thumbwheel_step(FL_OBJECT * ob, double step)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
f_step = library.convert_to_doublec(step)
library.keep_elem_refs(ptr_flobject, step, f_step)
retval = _fl_set_thumbwheel_step(ptr_flobject, f_step)
return retval
