Class CustomProp
- class ooodev.calc.cell.custom_prop.CustomProp(cell)[source]
A partial class for Calc Cell custom properties.
- Parameters:
cell (CalcCell) –
- class ContainerListener(form_name, cp, lo_inst, subscriber=None)[source]
- Parameters:
args (Any) –
kwargs (Any) –
- Return type:
Any
- __init__(form_name, cp, lo_inst, subscriber=None)[source]
- Parameters:
form_name (str) –
cp (CustomProp) –
lo_inst (LoInst) –
subscriber (XContainer | None) –
- Return type:
None
- disposing(event)[source]
Gets called when the broadcaster is about to be disposed.
All listeners and all other objects, which reference the broadcaster should release the reference to the source. No method should be invoked anymore on this object ( including
XComponent.removeEventListener()
).This method is called for every listener registration of derived listener interfaced, not only for registrations at
XComponent
.- Return type:
None
- Parameters:
event (com.sun.star.lang.EventObject) –
- elementInserted(event)[source]
Event is invoked when a container has inserted an element.
- Return type:
None
- Parameters:
event (com.sun.star.container.ContainerEvent) –
- elementRemoved(event)[source]
Event is invoked when a container has removed an element.
- Return type:
None
- Parameters:
event (com.sun.star.container.ContainerEvent) –
- __init__(cell)[source]
Constructor
- Parameters:
values (Dict[str, Any] | None, optional) – Dictionary Values. Defaults to None.
cell (CalcCell) –
- Return type:
None
- get_custom_properties()[source]
Gets custom properties.
- Returns:
custom properties.
- Return type:
DotDict
Hint
DotDict is a class that allows you to access dictionary keys as attributes or keys. DotDict can be imported from
ooodev.utils.helper.dot_dict.DotDict
.
- get_custom_property(name, default=<object object>)[source]
Gets a custom property.
- Parameters:
name (str) – The name of the property.
default (Any, optional) – The default value to return if the property does not exist.
- Raises:
AttributeError – If the property is not found.
- Returns:
The value of the property.
- Return type:
Any
- has_custom_properties()[source]
Gets if a custom property exists.
- Parameters:
name (str) – The name of the property to check.
- Returns:
True
if the property exists, otherwiseFalse
.- Return type:
bool
- has_custom_property(name)[source]
Gets if a custom property exists.
- Parameters:
name (str) – The name of the property to check.
- Returns:
True
if the property exists, otherwiseFalse
.- Return type:
bool
- remove_custom_property(name)[source]
Removes a custom property.
- Parameters:
name (str) – The name of the property to remove.
- Raises:
AttributeError – If the property is a forbidden key.
- Return type:
None
- set_custom_properties(properties)[source]
Sets custom properties.
- Parameters:
properties (DotDict) – custom properties to set.
- Return type:
None
Hint
DotDict is a class that allows you to access dictionary keys as attributes or keys. DotDict can be imported from
ooodev.utils.helper.dot_dict.DotDict
.- Return type:
None
- Parameters:
properties (DotDict) –