gws.base.client.core

Source code: gws.base.client.core

Module Contents

class gws.base.client.core.Config(*args, **kwargs)

Bases: gws.ConfigWithAccess

GWS client configuration

addElements: list[ElementConfig] | None

Add elements to the parent element list.

elements: list[ElementConfig] | None

Client UI elements.

options: dict | None

Client options.

removeElements: list[ElementConfig] | None

Remove elements from the parent element list.

class gws.base.client.core.Element

Bases: gws.Node

GWS object tree node.

after: str
before: str
tag: str
configure()

Configuration hook.

props(user)

Generate a Props struct for this object.

Parameters:

user – The user for which the props should be generated.

class gws.base.client.core.ElementConfig(*args, **kwargs)

Bases: gws.ConfigWithAccess

GWS client UI element configuration

after: str = ''

Insert after this tag.

before: str = ''

Insert before this tag.

tag: str

Element tag.

class gws.base.client.core.ElementProps(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

tag: str
class gws.base.client.core.Object

Bases: gws.Client

GWS Client control object.

elements: list[Element]
options: dict
configure()

Configuration hook.

props(user)

Generate a Props struct for this object.

Parameters:

user – The user for which the props should be generated.

class gws.base.client.core.Props(*args, **kwargs)

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

elements: list[ElementProps] | None
options: dict | None