`gws.plugin.qfield.core`¶

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.

package: Package¶

project: gws.Project¶

user: gws.User¶

baseDir: str¶

qgisFileName: str¶

dbFileName: str¶

dbPath: str¶

withBaseMap: bool¶

withData: bool¶

withMedia: bool¶

withQgis: bool¶

class gws.plugin.qfield.core.ImportArgs(*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.

package: Package¶

project: gws.Project¶

user: gws.User¶

baseDir: str¶

dbFileName: str¶

class gws.plugin.qfield.core.LayerAction¶

Bases: gws.Enum

Enumeration type.

Despite being declared as extending Enum (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn’t provide any Enum-specific utilities.

The rationale behind this is that we need Enum members (e.g. Color.RED) to be scalars, and not complex objects as in the standard Enum.

remove = 'remove'¶

edit = 'edit'¶

baseMap = 'baseMap'¶

class gws.plugin.qfield.core.EditAction¶

Bases: gws.Enum

Enumeration type.

Despite being declared as extending Enum (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn’t provide any Enum-specific utilities.

The rationale behind this is that we need Enum members (e.g. Color.RED) to be scalars, and not complex objects as in the standard Enum.

update = 'update'¶

geometryUpdate = 'geometryUpdate'¶

insert = 'insert'¶

delete = 'delete'¶

class gws.plugin.qfield.core.EditOperation(*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.

action: EditAction¶

fid: int¶

pkey: str¶

columnName: str¶

attributes: dict¶

class gws.plugin.qfield.core.ModelEntry(*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.

gpId: int¶

gpName: str¶

model: gws.DatabaseModel¶

fidToPkey: dict¶

columnIndex: dict¶

editOperations: list[EditOperation]¶

features: list[gws.Feature]¶

class gws.plugin.qfield.core.LayerEntry(*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.

action: LayerAction¶

qgisId: str¶

modelEntry: ModelEntry¶

readOnly: bool¶

sqlFilter: str¶

dataSourceFileName: str¶

dataSourcePath: str¶

dataSource: str¶

dataProvider: str¶

sourceLayer: gws.SourceLayer¶

class gws.plugin.qfield.core.QFieldCaps(*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.

qgisPath: str¶

layerMap: dict[str, LayerEntry]¶

modelMap: dict[str, ModelEntry]¶

globalProps: dict¶

dirsToCopy: list[str]¶

baseMapLayerIds: list[str]¶

areaOfInterest: gws.Bounds | None¶

offlineCopyOnlyAoi: bool¶

class gws.plugin.qfield.core.OfflineLog(*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.