Foundry.BuildAddin

g Foundry.BuildAddin Foundry.BuildAddin Foundry.Contextual Foundry.Contextual Foundry.Contextual->Foundry.BuildAddin GObject.GInterface GObject.GInterface Json.Serializable Json.Serializable GObject.GInterface->Json.Serializable GObject.Object GObject.Object GObject.Object->Foundry.Contextual Json.Serializable->Foundry.Contextual

Subclasses:

Foundry.PluginBuildAddin

Methods

Inherited:

Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8)

Structs:

GObject.ObjectClass (5)

discover_build_system ()

dup_pipeline ()

dup_plugin_info ()

Virtual Methods

Inherited:

GObject.Object (7), Json.Serializable (5)

do_discover_build_system ()

Properties

Inherited:

Foundry.Contextual (1)

Name

Type

Flags

Short Description

pipeline

Foundry.BuildPipeline

r/w/co

plugin-info

Peas.PluginInfo

r/w/co

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent_instance

Foundry.Contextual

r

Class Details

class Foundry.BuildAddin(**kwargs)
Bases:

Foundry.Contextual

Abstract:

Yes

Structure:

Foundry.BuildAddinClass

Customize build pipelines from plugins.

This class provides plugins the ability to modify how a build pipeline works by registering stages in the pipeline.

discover_build_system()
Returns:

a [class`Dex`.Future] that resolves to a string name of the build system or rejects with error.

Return type:

Dex.Future

Discover the build system used by the project.

This may be called _before_ [vfunc`Foundry`.BuildAddin.load] is called so that addins may discover what build system should be used. If the user has already specified a build system then this will not be called during pipeline initialization.

New in version 1.1.

dup_pipeline()
Returns:

a [class`Foundry`.BuildPipeline or None if the pipeline has been destroyed.

Return type:

Foundry.BuildPipeline or None

Gets the pipeline for which the addin belongs.

dup_plugin_info()
Returns:

a [class`Peas`.PluginInfo]

Return type:

Peas.PluginInfo or None

do_discover_build_system() virtual
Returns:

a [class`Dex`.Future] that resolves to a string name of the build system or rejects with error.

Return type:

Dex.Future

Discover the build system used by the project.

This may be called _before_ [vfunc`Foundry`.BuildAddin.load] is called so that addins may discover what build system should be used. If the user has already specified a build system then this will not be called during pipeline initialization.

New in version 1.1.

Property Details

Foundry.BuildAddin.props.pipeline
Name:

pipeline

Type:

Foundry.BuildPipeline

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

Foundry.BuildAddin.props.plugin_info
Name:

plugin-info

Type:

Peas.PluginInfo

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY