Class KeyValCancelArgs

class ooodev.events.args.key_val_cancel_args.KeyValCancelArgs(source, key, value, cancel=False)[source]

Bases: AbstractKeyValueArgs

Key Value Cancel Args

New in version 0.9.0.

Parameters:
  • source (Any) –

  • key (str) –

  • value (Any) –

  • cancel (bool) –

__init__(source, key, value, cancel=False)

Constructor

Parameters:
  • source (Any) – Event Source

  • key (str) – Key

  • (Any (value) – Value

  • value (Any) –

Return type:

None

static from_args(args)[source]

Gets a new instance from existing instance

Parameters:

args (KeyValCancelArgs) – Existing Instance

Returns:

args

Return type:

KeyValCancelArgs

get(key, default=<object object>)

Gets user data from event.

Parameters:
  • key (str) – Key used to store data

  • default (Any, optional) – Default value to return if key is not found.

Returns:

Data for key if found; Otherwise, if default is set then default.

Return type:

Any

New in version 0.9.0.

has(key)

Gets if a key exist in the instance

Parameters:

key (str) – key

Returns:

True if key exist; Otherwise False

Return type:

bool

New in version 0.9.0.

remove(key)

Removes key value pair from instance

Parameters:

key (str) – key

Returns:

True if key was found and removed; Otherwise, False

Return type:

bool

New in version 0.9.0.

set(key, value, allow_overwrite=True)

Sets a key value pair for event instance.

Parameters:
  • key (str) – Key

  • value (Any) – Value

  • allow_overwrite (bool, optional) – If True and a key already exist then its value will be over written; Otherwise value will not be over written. Defaults to True.

Returns:

True if values is written; Otherwise, False

Return type:

bool

New in version 0.9.0.

cancel: bool

Gets/Sets cancel value

cmd: str

Gets/Sets the dispatch cmd of the event

default
event_data: Any

Gets/Sets any extra data associated with the event

property event_name: str

Gets the event name for these args

Return type:

str

property event_source: Any | None

Gets the event source for these args

Return type:

Any | None

handled: bool

Get/Set Handled value. Typically if set to True then cancel is ignored.

key
source: Any

Gets/Sets Event source

value