Class
IdeBuildManager
Ancestors
- IdeObject
- GObject
Instance methods
ide_build_manager_build_async
This function will request that phase
is completed in the underlying
build pipeline and execute a build. Upon completion, callback
will be
executed and it can determine the success or failure of the operation
using ide_build_manager_build_finish()
.
Available since: 3.32
ide_build_manager_build_finish
Completes a request to ide_build_manager_build_async()
.
Available since: 3.32
ide_build_manager_clean_async
Asynchronously requests that the build pipeline clean up to phase
.
Available since: 3.32
ide_build_manager_clean_finish
Completes an asynchronous request to ide_build_manager_clean_async()
.
Available since: 3.32
ide_build_manager_get_busy
Gets if the IdeBuildManager
is currently busy building the project.
Available since: 3.32
ide_build_manager_get_can_build
Checks if the current pipeline is ready to build.
Available since: 3.32
ide_build_manager_get_error_count
ide_build_manager_get_last_build_time
This function returns a GDateTime
of the last build request. If
there has not yet been a build request, this will return NULL
.
Available since: 3.32
ide_build_manager_get_message
This function returns the current build message as a string.
Available since: 3.32
ide_build_manager_get_pipeline
This function gets the current build pipeline. The pipeline will be reloaded as build configurations change.
Available since: 3.32
ide_build_manager_get_running_time
Gets the amount of elapsed time of the current build as a
GTimeSpan
.
Available since: 3.32
ide_build_manager_get_warning_count
ide_build_manager_invalidate
Requests that the IdeBuildManager
invalidate the current pipeline and
setup a new pipeline.
Available since: 3.32
ide_build_manager_rebuild_async
Asynchronously requests that the build pipeline clean and rebuild up to the given phase. This may involve discarding previous build artifacts to allow for the rebuild process.
Available since: 3.32
ide_build_manager_rebuild_finish
Completes an asynchronous request to ide_build_manager_rebuild_async()
.
Available since: 3.32
ide_build_manager_ref_pipeline
A thread-safe variant of ide_build_manager_get_pipeline()
.
Available since: 3.32
Methods inherited from IdeObject (28)
ide_object_add
Adds child
to self
, with location dependent on location
.
Available since: 3.32
ide_object_append
Inserts child
as the last child of self
.
Available since: 3.32
ide_object_destroy
ide_object_ensure_child_typed
Like ide_object_get_child_typed()
except that it creates an object of
type
if it is missing.
Available since: 3.32
ide_object_foreach
Calls callback
for each child of self
.
Available since: 3.32
ide_object_get_child_typed
Finds the first child of self
that is of type
.
Available since: 3.32
ide_object_get_children_typed
Gets all children matching type
.
Available since: 3.32
ide_object_get_context
Gets the IdeContext
for the object.
Available since: 3.32
ide_object_get_n_children
Gets the number of children for an object.
Available since: 3.32
ide_object_get_nth_child
Gets the nth
child of self
.
Available since: 3.32
ide_object_get_parent
Gets the parent IdeObject
, if any.
Available since: 3.32
ide_object_get_position
Gets the position of self
within the parent node.
Available since: 3.32
ide_object_in_destruction
ide_object_insert_after
Inserts child
into self
‘s children, directly after sibling
.
Available since: 3.32
ide_object_insert_before
Inserts child
into self
‘s children, directly before sibling
.
Available since: 3.32
ide_object_insert_sorted
Locates the proper sibling for child
by using func
amongst self
‘s
children IdeObject
. Those objects must already be sorted.
Available since: 3.32
ide_object_is_root
Checks if self
is root, meaning it has no parent.
Available since: 3.32
ide_object_lock
Acquires the lock for self
. This can be useful when you need to do
multi-threaded work with self
and want to ensure exclusivity.
Available since: 3.32
ide_object_prepend
Inserts child
as the first child of self
.
Available since: 3.32
ide_object_ref_cancellable
Gets a GCancellable
for the object.
Available since: 3.32
ide_object_ref_context
Gets the root IdeContext
for the object, if any.
Available since: 3.32
ide_object_ref_parent
Gets the parent IdeObject
, if any.
Available since: 3.32
ide_object_ref_root
Finds and returns the toplevel object in the tree.
Available since: 3.32
Properties
Ide.BuildManager:busy
The “busy” property indicates if there is currently a build executing. This can be bound to UI elements to display to the user that a build is active (and therefore other builds cannot be activated at the moment).
Available since: 3.32
Ide.BuildManager:can-build
Gets if the build manager can queue a build request.
Available since: 3.32
Ide.BuildManager:error-count
The number of errors discovered during the build process.
Available since: 3.32
Ide.BuildManager:has-diagnostics
The “has-diagnostics” property indicates that there have been diagnostics found during the last execution of the build pipeline.
Available since: 3.32
Ide.BuildManager:last-build-time
The “last-build-time” property contains a GDateTime
of the time
the last build request was submitted.
Available since: 3.32
Ide.BuildManager:message
The “message” property contains a string message describing the current state of the build process. This may be bound to UI elements to notify the user of the buid progress.
Available since: 3.32
Ide.BuildManager:pipeline
The “pipeline” property is the build pipeline that the build manager is currently managing.
Available since: 3.32
Ide.BuildManager:running-time
The “running-time” property can be bound by UI elements that
want to track how long the current build has taken. g_object_notify()
is called on a regular interval during the build so that the UI
elements may automatically update.
Available since: 3.32
Ide.BuildManager:warning-count
The “warning-count” property contains the number of warnings that have been discovered in the current build request.
Available since: 3.32
Properties inherited from IdeObject (2)
Ide.Object:cancellable
The “cancellable” property is a GCancellable
that can be used by operations
that will be cancelled when the IdeObject::destroy
signal is emitted on self
.
Available since: 3.32
Ide.Object:parent
The parent IdeObject
, if any.
Available since: 3.32
Signals
Ide.BuildManager::build-failed
The “build-failed” signal is emitted when a build that was previously
notified via IdeBuildManager::build-started
has failed to complete successfully.
Available since: 3.32
Ide.BuildManager::build-finished
The “build-finished” signal is emitted when a build completed successfully.
Available since: 3.32
Ide.BuildManager::build-started
The “build-started” signal is emitted when a new build has started.
The build may be an incremental build. The pipeline
instance is
the build pipeline which is being executed.
Available since: 3.32
Signals inherited from IdeObject (1)
Ide.Object::destroy
The “destroy” signal is emitted when the object should destroy itself and cleanup any state that is no longer necessary. This happens when the object has been removed from the because it was requested to be destroyed, or because a parent object is being destroyed.
Available since: 3.32
Class structure
struct IdeBuildManagerClass {
IdeObjectClass parent_class;
}
Class members
parent_class |
|
No description available. |