def fl_get_nmenu_popup(ptr_flobject):
"""fl_get_nmenu_popup(ptr_flobject) -> ptr_flpopup
Finds out which popup is associated with the nmenu flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
nmenu flobject
Returns
-------
ptr_flpopup : pointer to xfdata.FL_POPUP
popup class instance
Examples
--------
>>> *todo*
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_get_nmenu_popup = library.cfuncproto(
library.load_so_libforms(), "fl_get_nmenu_popup",
cty.POINTER(xfdata.FL_POPUP), [cty.POINTER(xfdata.FL_OBJECT)],
"""FL_POPUP * fl_get_nmenu_popup(FL_OBJECT * p1)""")
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
retval = _fl_get_nmenu_popup(ptr_flobject)
return retval
def fl_get_spinner_step(ptr_flobject):
"""fl_get_spinner_step(ptr_flobject) -> step
Finds out step that spinner values are rounded to.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
spinner flobject
Returns
-------
step : float
step values are rounded to
Examples
--------
>>> *todo*
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_get_spinner_step = library.cfuncproto(
library.load_so_libforms(), "fl_get_spinner_step",
cty.c_double, [cty.POINTER(xfdata.FL_OBJECT)],
"""double fl_get_spinner_step(FL_OBJECT * obj)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
retval = _fl_get_spinner_step(ptr_flobject)
return retval
def fl_get_spinner_precision(ptr_flobject):
"""fl_get_spinner_precision(ptr_flobject) -> precis
Finds out the precision of values in a spinner flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
spinner flobject
Returns
-------
precis : int
precision number after the dot, or 0 (if it is of type
xfdata.FL_INT_SPINNER)
Examples
--------
>>> *todo*
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_get_spinner_precision = library.cfuncproto(
library.load_so_libforms(), "fl_get_spinner_precision",
cty.c_int, [cty.POINTER(xfdata.FL_OBJECT)],
"""int fl_get_spinner_precision(FL_OBJECT * obj)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
retval = _fl_get_spinner_precision(ptr_flobject)
return retval
def fl_get_spinner_value(ptr_flobject):
"""fl_get_spinner_value(ptr_flobject) -> spvalue
Finds out value of a spinner flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
spinner flobject
Returns
-------
spvalue : float
spinner value
Examples
--------
>>> val = fl_get_spinner_value(pspnobj)
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_get_spinner_value = library.cfuncproto(
library.load_so_libforms(), "fl_get_spinner_value",
cty.c_double, [cty.POINTER(xfdata.FL_OBJECT)],
"""double fl_get_spinner_value(FL_OBJECT * obj)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
retval = _fl_get_spinner_value(ptr_flobject)
return retval
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_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_positioner_mouse_buttons(ptr_flobject, mousebtns):
"""fl_set_positioner_mouse_buttons(ptr_flobject, mousebtns)
Defines which mouse buttons the positioner flobject will react to.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
positioner flobject
mousebtns : int_pos
*todo*
Example
-------
>>> *todo*
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_positioner_mouse_buttons = library.cfuncproto(
library.load_so_libforms(), "fl_set_positioner_mouse_buttons",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_uint],
"""void fl_set_positioner_mouse_buttons(FL_OBJECT * ob,
unsigned int mount_buttons)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
ui_mousebtns = library.convert_to_uintc(mousebtns)
library.keep_elem_refs(ptr_flobject, mousebtns, ui_mousebtns)
_fl_set_positioner_ystep(ptr_flobject, ui_mousebtns)
def fl_set_glcanvas_direct(ptr_flobject, yesno):
"""fl_set_glcanvas_direct(ptr_flobject, yesno)
Changes the rendering context created by a glcanvas flobject. By default
it uses direct rendering (i.e. by-passing the Xserver).
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
glcanvas flobject
yesno : int
flag to use direct or through-Xserver rendering. Values 0 (to use
Xserver rendering) or 1 (to use direct rendering)
Examples
--------
>>> fl_set_glcanvas_direct(pglcnvobj, 0)
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_set_glcanvas_direct = library.cfuncproto(
library.load_so_libformsgl(), "fl_set_glcanvas_direct",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_int],
"""void fl_set_glcanvas_direct(FL_OBJECT * ob, int direct)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
i_yesno = library.convert_to_intc(yesno)
library.keep_elem_refs(ptr_flobject, yesno, i_yesno)
_fl_set_glcanvas_direct(ptr_flobject, i_yesno)
def fl_activate_glcanvas(ptr_flobject):
"""fl_activate_glcanvas(ptr_flobject)
Activates a glcanvas flobject before drawing into glcanvas flobject.
OpenGL drawing routines always draw into the window the current context
is bound to. For application with a single canvas, this is not a problem.
In case of multiple canvases, the canvas driver takes care of setting the
proper context before invoking the expose handler. In some cases, the
application may want to draw into canvases actively. In this case, use
this function for explicit drawing context switching.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
glcanvas flobject
Examples
--------
>>> fl_activate_glcanvas(pglcnvobj)
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_activate_glcanvas = library.cfuncproto(
library.load_so_libformsgl(), "fl_activate_glcanvas",
None, [cty.POINTER(xfdata.FL_OBJECT)],
"""void fl_activate_glcanvas(FL_OBJECT * ob)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
_fl_activate_glcanvas(ptr_flobject)
def fl_suspend_timer(ptr_flobject):
"""fl_suspend_timer(ptr_flobject)
Suspends timer, pausing time.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
timer flobject
Examples
--------
>>> fl_suspend_timer(ptimerobj)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_suspend_timer = library.cfuncproto(
library.load_so_libforms(), "fl_suspend_timer",
None, [cty.POINTER(xfdata.FL_OBJECT)],
"""void fl_suspend_timer(FL_OBJECT * ob)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
_fl_suspend_timer(ptr_flobject)
def fl_resume_timer(ptr_flobject):
"""fl_resume_timer(ptr_flobject)
Resumes timer previously paused (with fl_suspend_timer). Unlike
fl_set_timer() a suspended timer keeps its internal state (total
delay, time left etc.), so when it is resumed, it starts from where
it was suspended.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
timer flobject
Examples
--------
>>> fl_resume_timer(ptimobj)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_resume_timer = library.cfuncproto(
library.load_so_libforms(), "fl_resume_timer",
None, [cty.POINTER(xfdata.FL_OBJECT)],
"""void fl_resume_timer(FL_OBJECT * ob)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
_fl_resume_timer(ptr_flobject)
def fl_set_timer_countup(ptr_flobject, yesno):
"""fl_set_timer_countup(ptr_flobject, yesno)
Changes timer behavior so the timer counts up and shows elapsed time.
By default, a timer counts down toward zero and the value shown (for
xfdata.FL_VALUE_TIMERs) is the time left until the timer expires.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
timer flobject
yesno : int
flag to set count up or down. Values 0 (counts down and shows time
left) or 1 (counts up and shows elapsed time)
Examples
--------
>>> fl_set_timer_countup(ptimerobj, 1)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_timer_countup = library.cfuncproto(
library.load_so_libforms(), "fl_set_timer_countup",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_int],
"""void fl_set_timer_countup(FL_OBJECT * ob, int yes)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
i_yesno = library.convert_to_intc(yesno)
library.keep_elem_refs(ptr_flobject, yesno, i_yesno)
_fl_set_timer_countup(ptr_flobject, i_yesno)
def fl_get_timer(ptr_flobject):
"""fl_get_timer(ptr_flobject) -> lefttime
Finds out the time left in the timer.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
timer flobject
Returns
-------
lefttime : float
time left
Examples
--------
>>> lefttim = fl_get_timer(ptimerobj)
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_get_timer = library.cfuncproto(
library.load_so_libforms(), "fl_get_timer",
cty.c_double, [cty.POINTER(xfdata.FL_OBJECT)],
"""double fl_get_timer(FL_OBJECT * ob)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
retval = _fl_get_timer(ptr_flobject)
return retval
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_button(ptr_flobject, yesno):
"""fl_set_button(ptr_flobject, yesno)
Defines the button state (not pushed, or pushed).
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
button flobject
yesno : int
state of button to be set. Values 0 (if not pushed)
or 1 (if pushed)
Examples
--------
>>> fl_set_button(btnobj, 1)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_button = library.cfuncproto(
library.load_so_libforms(), "fl_set_button",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_int],
"""void fl_set_button(FL_OBJECT * ob, int pushed)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
i_yesno = library.convert_to_intc(yesno)
library.keep_elem_refs(ptr_flobject, yesno, i_yesno)
_fl_set_button(ptr_flobject, yesno)
def fl_get_glcanvas_xvisualinfo(ptr_flobject):
"""fl_get_glcanvas_xvisualinfo(ptr_flobject) -> ptr_xvisualinfo
Finds out the XVisual information that is used to create the context of
a glcanvas flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
glcanvas flobject
Returns
-------
ptr_xvisualinfo : pointer to xfdata.XVisualInfo
XVisualInfo instance class
Examples
--------
>>> pxviscls = fl_get_glcanvas_xvisualinfo(pglcnvobj)
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_get_glcanvas_xvisualinfo = library.cfuncproto(
library.load_so_libformsgl(), "fl_get_glcanvas_xvisualinfo",
cty.POINTER(xfdata.XVisualInfo), [cty.POINTER(xfdata.FL_OBJECT)],
"""XVisualInfo * fl_get_glcanvas_xvisualinfo(FL_OBJECT * ob)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
retval = _fl_get_glcanvas_xvisualinfo(ptr_flobject)
return retval
def fl_get_positioner_xvalue(ptr_flobject):
"""fl_get_positioner_xvalue(ptr_flobject) -> xvalue
Finds out value of positioner flobject in horizontal direction.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
positioner flobject
Returns
-------
xvalue : float
value in horizontal direction
Examples
--------
>>> val = fl_get_positioner_xvalue(pstobj)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_get_positioner_xvalue = library.cfuncproto(
library.load_so_libforms(), "fl_get_positioner_xvalue",
cty.c_double, [cty.POINTER(xfdata.FL_OBJECT)],
"""double fl_get_positioner_xvalue(FL_OBJECT * ob)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
retval = _fl_get_positioner_xvalue(ptr_flobject)
return retval
def fl_get_glcanvas_context(ptr_flobject):
"""fl_get_glcanvas_context(ptr_flobject) -> glxcontext
Finds out GLXContext of a glcanvas flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
glcanvas flobject
Returns
-------
glxcontext : xfdata.GLXContext
glxcontext class instance
Examples
--------
>>> glxcont = fl_get_glcanvas_context(pglcnvobj)
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_get_glcanvas_context = library.cfuncproto(
library.load_so_libformsgl(), "fl_get_glcanvas_context",
xfdata.GLXContext, [cty.POINTER(xfdata.FL_OBJECT)],
"""GLXContext fl_get_glcanvas_context(FL_OBJECT * ob)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
retval = _fl_get_glcanvas_context(ptr_flobject)
return retval
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_button_mouse_buttons(ptr_flobject, buttons):
"""fl_set_button_mouse_buttons(ptr_flobject, buttons)
Defines up to which mouse buttons the button flobject will react.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
button flobject
buttons : int_pos
value of mouse buttons to be set. Values bitwise 'OR' of the
numbers 1 for the left mouse button, 2 for the middle, 4 for
the right mouse button, 8 for moving the scroll wheel up
"button" and 16 for scrolling down "button".
Examples
--------
>>> fl_set_button_mouse_buttons(pbtnobj, 8|16)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_button_mouse_buttons = library.cfuncproto(
library.load_so_libforms(), "fl_set_button_mouse_buttons",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_uint],
"""void fl_set_button_mouse_buttons(FL_OBJECT * ob,
unsigned int buttons)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
ui_buttons = library.convert_to_uintc(buttons)
library.keep_elem_refs(ptr_flobject, buttons, ui_buttons)
_fl_set_button_mouse_buttons(ptr_flobject, ui_buttons)
def fl_get_positioner_numb(ptr_flobject):
"""fl_get_positioner_numb(ptr_flobject) -> mousebtn
Retrieves the number of the last used mouse button. It is returned
by flbasic.fl_mouse_button, too.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
positioner flobject
Returns
-------
mousebtn : int
*todo*
Example
-------
>>> *todo*
Notes
-----
Status: NA-UTest + Doc + NoDemo = OK
"""
_fl_get_positioner_numb = library.cfuncproto(
library.load_so_libforms(), "fl_get_positioner_numb",
cty.c_int, [cty.POINTER(xfdata.FL_OBJECT)],
"""int fl_get_positioner_numb(FL_OBJECT * ob)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
i_mousebtn = library.convert_to_intc(mousebtn)
library.keep_elem_refs(ptr_flobject, mousebtn, i_mousebtn)
retval = _fl_get_positioner_numb(ptr_flobject, i_mousebtn)
return retval
def fl_set_pixmapbutton_focus_outline(ptr_flobject, yesno):
"""fl_set_pixmapbutton_focus_outline(ptr_flobject, yesno)
Enables or disables the focus outline of the pixmap button.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
button flobject
yesno : int
flag to enable (1) or disable (0) the focus outline
Examples
--------
>>> fl_set_pixmapbutton_focus_outline(pmapobj, 1)
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_set_pixmapbutton_focus_outline = library.cfuncproto(
library.load_so_libforms(), "fl_set_pixmapbutton_focus_outline",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_int],
"""void fl_set_pixmapbutton_focus_outline(FL_OBJECT * ob, int yes)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
i_yesno = library.convert_to_intc(yesno)
library.keep_elem_refs(ptr_flobject, yesno, i_yesno)
_fl_set_pixmapbutton_focus_outline(ptr_flobject, i_yesno)
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_pixmapbutton_focus_data(ptr_flobject, xpmdata):
"""fl_set_pixmapbutton_focus_data(ptr_flobject, xpmdata)
Defines a different pixmap to show, using data, when the mouse enters
a pixmap button flobject, instead of an outline of the button.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
button flobject
xpmdata : str of ubytes
pixmap data
Examples
--------
>>> *todo*
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_set_pixmapbutton_focus_data = library.cfuncproto(
library.load_so_libforms(), "fl_set_pixmapbutton_focus_data",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.POINTER(xfdata.STRING)],
"""void fl_set_pixmapbutton_focus_data(FL_OBJECT * ob,
char * * bits)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
#ptr_bits = cty.cast(bits, cty.POINTER(xfdata.STRING))
ptr_xpmdata = library.convert_to_ptr_ubytec(xpmdata)
library.keep_elem_refs(ptr_flobject, xpmdata, ptr_xpmdata)
_fl_set_pixmapbutton_focus_data(ptr_flobject, ptr_xpmdata)
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_pixmapbutton_focus_file(ptr_flobject, fname):
"""fl_set_pixmapbutton_focus_file(ptr_flobject, fname)
Defines a different pixmap to show, using a file, when the mouse enters
a pixmap button flobject, instead of an outline of the button.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
button flobject
fname : str
name of file containing pixmap resource
Examples
--------
>>> *todo*
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_pixmapbutton_focus_file = library.cfuncproto(
library.load_so_libforms(), "fl_set_pixmapbutton_focus_file",
None, [cty.POINTER(xfdata.FL_OBJECT), xfdata.STRING],
"""void fl_set_pixmapbutton_focus_file(FL_OBJECT * ob,
const char * fname)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
s_fname = library.convert_to_bytestrc(fname)
library.keep_elem_refs(ptr_flobject, fname, s_fname)
_fl_set_pixmapbutton_focus_file(ptr_flobject, s_fname)
def fl_set_spinner_precision(ptr_flobject, precis):
"""fl_set_spinner_precision(ptr_flobject, precis)
Defines the precision number of values in a spinner flobject. It has
no effect on xfdata.FL_INT_SPINNER flobjects.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
spinner flobject
precis : int
precision value to be set after the decimal point. By default it
is set to 6 digits.
Examples
--------
>>> fl_set_spinner_precision(pspnobj, 2)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_set_spinner_precision = library.cfuncproto(
library.load_so_libforms(), "fl_set_spinner_precision",
None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_int],
"""void fl_set_spinner_precision(FL_OBJECT * obj, int prec)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
i_precis = library.convert_to_intc(precis)
library.keep_elem_refs(ptr_flobject, precis, i_precis)
_fl_set_spinner_precision(ptr_flobject, i_precis)
def fl_get_button(ptr_flobject):
"""fl_get_button(ptr_flobject) -> btnstate
Finds out the push state value of a button flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
button flobject
Returns
-------
btnstate : int
push state. Values 0 (not pushed) or 1 (pushed)
Examples
--------
>>> btnstate = fl_get_button(btnobj)
Notes
-----
Status: NA-UTest + Doc + Demo = OK
"""
_fl_get_button = library.cfuncproto(
library.load_so_libforms(), "fl_get_button",
cty.c_int, [cty.POINTER(xfdata.FL_OBJECT)],
"""int fl_get_button(FL_OBJECT * ob)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
retval = _fl_get_button(ptr_flobject)
return retval
def fl_get_spinner_down_button(ptr_flobject):
"""fl_get_spinner_down_button(ptr_flobject) -> ptr_flobject
Retrieves down button element of a spinner flobject.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
spinner flobject
Returns
-------
ptr_flobject : pointer to xfdata.FL_OBJECT
down button element of spinner flobject
Examples
--------
>>> *todo*
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_get_spinner_down_button = library.cfuncproto(
library.load_so_libforms(), "fl_get_spinner_down_button",
cty.POINTER(xfdata.FL_OBJECT), [cty.POINTER(xfdata.FL_OBJECT)],
"""FL_OBJECT * fl_get_spinner_down_button(FL_OBJECT * obj)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
retval = _fl_get_spinner_down_button(ptr_flobject)
return retval
def fl_clear_nmenu(ptr_flobject):
"""fl_clear_nmenu(ptr_flobject) -> result
Removes all items from a nmenu flobject at once.
Parameters
----------
ptr_flobject : pointer to xfdata.FL_OBJECT
nmenu flobject
Returns
-------
result : int
0 (on success), or -1 (on failure)
Examples
--------
>>> rsl = fl_clear_nmenu(nmnobj)
Notes
-----
Status: NA-UTest + Doc + NoDemo = Maybe
"""
_fl_clear_nmenu = library.cfuncproto(
library.load_so_libforms(), "fl_clear_nmenu",
cty.c_int, [cty.POINTER(xfdata.FL_OBJECT)],
"""int fl_clear_nmenu(FL_OBJECT * p1)""")
library.check_if_flinitialized()
library.verify_flobjectptr_type(ptr_flobject)
library.keep_elem_refs(ptr_flobject)
retval = _fl_clear_nmenu(ptr_flobject)
return retval
