Class FormCtlCheckBox

Introduction

Class for working with Check Box controls in a form.

EventArgsCallbackT

All EventArgsCallbackT callbacks include control_src as a keyword argument.

A callback can be in the format of:

def on_some_event(
    src: Any, event: EventArgs, control_src: FormCtlCheckBox, *args, **kwargs
) -> None:
    pass

or

def on_some_event(src: Any, event: EventArgs, *args, **kwargs) -> None:
    # can get control from kwargs
    ctl = cast(FormCtlCheckBox, kwargs['control_src'])

Class

class ooodev.form.controls.FormCtlCheckBox(ctl, lo_inst=None)[source]

Bases: FormCtlBase, ItemEvents, ResetEvents

com.sun.star.form.component.CheckBox control

Parameters:

ctl (XControl) –
lo_inst (LoInst | None) –

__init__(ctl, lo_inst=None)[source]

Constructor

Parameters:

ctl (XControl) – Control supporting com.sun.star.form.component.CheckBox service.
lo_inst (LoInst, optional) – Lo Instance. Use when creating multiple documents. Defaults to None.

Return type:

None

Note

If the LoContext manager is use before this class is instantiated, then the Lo instance will be set using the current Lo instance. That the context manager has set. Generally speaking this means that there is no need to set lo_inst when instantiating this class.