Python library.load_so_libforms函数代码示例

def fl_share_canvas_colormap(ptr_flobject, colormap):
    """fl_share_canvas_colormap(ptr_flobject, colormap)

    Defines the color property of canvas flobject. It also sets an internal
    flag so the colormap is not freed when the canvas goes away.

    Parameters
    ----------
        ptr_flobject : pointer to xfdata.FL_OBJECT
            canvas flobject
        colormap : long_pos
            colormap of canvas

    Examples
    --------
        >>> *todo*

    Notes
    -----
        Status: NA-UTest + Doc + NoDemo = Maybe

    """
    _fl_share_canvas_colormap = library.cfuncproto(
        library.load_so_libforms(), "fl_share_canvas_colormap",
        None, [cty.POINTER(xfdata.FL_OBJECT), xfdata.Colormap],
        """void fl_share_canvas_colormap(FL_OBJECT * ob, Colormap colormap)""")
    library.check_if_flinitialized()
    library.verify_flobjectptr_type(ptr_flobject)
    ul_colormap = library.convert_to_ulongc(colormap)
    library.keep_elem_refs(ptr_flobject, colormap, ul_colormap)
    _fl_share_canvas_colormap(ptr_flobject, ul_colormap)

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_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_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_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_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_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

def fl_canvas_yield_to_shortcut(ptr_flobject, yesno):
    """fl_canvas_yield_to_shortcut(ptr_flobject, yesno)

    Enables or disables keyboard input's stealing by canvas. By default,
    flobjects with shortcuts appearing on the same form as the canvas will
    "steal" keyboard inputs if they match the shortcuts.

    Parameters
    ----------
        ptr_flobject : pointer to xfdata.FL_OBJECT
            canvas flobject
        yesno : int
            flag to enable/disable keyboard input's stealing by canvas.
            Values 0 (to disable) or 1 (to enable)

    Examples
    --------
        >>> fl_canvas_yield_to_shortcut(pcanvobj, 1)

    Notes
    -----
        Status: NA-UTest + Doc + NoDemo = Maybe

    """
    _fl_canvas_yield_to_shortcut = library.cfuncproto(
        library.load_so_libforms(), "fl_canvas_yield_to_shortcut",
        None, [cty.POINTER(xfdata.FL_OBJECT), cty.c_int],
        """void fl_canvas_yield_to_shortcut(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_canvas_yield_to_shortcut(ptr_flobject, i_yesno)

def fl_clear_canvas(ptr_flobject):
    """fl_clear_canvas(ptr_flobject)

    Clears the canvas to the background color. If no background is defined,
    uses black.

    Parameters
    ----------
        ptr_flobject : pointer to xfdata.FL_OBJECT
            canvas flobject

    Examples
    --------
        >>> fl_clear_canvas(pcanvobj)

    Notes
    -----
        Status: NA-UTest + Doc + NoDemo = Maybe

    """
    _fl_clear_canvas = library.cfuncproto(
        library.load_so_libforms(), "fl_clear_canvas",
        None, [cty.POINTER(xfdata.FL_OBJECT)],
        """void fl_clear_canvas(FL_OBJECT * ob)""")
    library.check_if_flinitialized()
    library.verify_flobjectptr_type(ptr_flobject)
    library.keep_elem_refs(ptr_flobject)
    _fl_clear_canvas(ptr_flobject)

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)