gws.base.client.core

Source code: gws.base.client.core

Module Contents

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

Bases: gws.ConfigWithAccess

GWS client UI element configuration

tag: str

element tag

before: str = ''

insert before this tag

after: str = ''

insert after this tag

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

Bases: gws.ConfigWithAccess

GWS client configuration

options: dict | None

client options

elements: list[ElementConfig] | None

client UI elements

addElements: list[ElementConfig] | None

add elements to the parent element list

removeElements: list[ElementConfig] | None

remove elements from the parent element list

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

options: dict | None

elements: list[ElementProps] | None

class gws.base.client.core.Element

Bases: gws.Node

Configurable GWS object.

tag: str

after: str

before: 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.Object

Bases: gws.Client

GWS Client control object.

options: dict

elements: list[Element]

configure()

Configuration hook.

props(user)

Generate a Props struct for this object.

Parameters:

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