Top | ![]() |
![]() |
![]() |
![]() |
void | ide_configuration_provider_emit_added () |
void | ide_configuration_provider_emit_removed () |
void | ide_configuration_provider_load_async () |
gboolean | ide_configuration_provider_load_finish () |
void | ide_configuration_provider_save_async () |
gboolean | ide_configuration_provider_save_finish () |
void | ide_configuration_provider_delete () |
void | ide_configuration_provider_duplicate () |
void | ide_configuration_provider_unload () |
void ide_configuration_provider_emit_added (IdeConfigurationProvider *self
,IdeConfiguration *config
);
IdeConfigurationProvider implementations should call this function with
a config
when it has discovered a new configuration.
Since: 3.28
void ide_configuration_provider_emit_removed (IdeConfigurationProvider *self
,IdeConfiguration *config
);
IdeConfigurationProvider implementations should call this function with
a config
when it has discovered it was removed.
Since: 3.28
void ide_configuration_provider_load_async (IdeConfigurationProvider *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
This function is called to initialize the configuration provider after
the plugin instance has been created. The provider should locate any
build configurations within the project and call
ide_configuration_provider_emit_added()
before completing the
asynchronous function so that the configuration manager may be made
aware of the configurations.
self |
||
cancellable |
a GCancellable or |
[nullable] |
callback |
a callback to execute upon completion |
|
user_data |
closure data for |
Since: 3.28
gboolean ide_configuration_provider_load_finish (IdeConfigurationProvider *self
,GAsyncResult *result
,GError **error
);
Completes an asynchronous request to ide_configuration_provider_load_async()
.
void ide_configuration_provider_save_async (IdeConfigurationProvider *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
This function is called to request that the configuration provider persist any changed configurations back to disk.
This function will be called before unloading the configuration provider so that it has a chance to persist any outstanding changes.
gboolean ide_configuration_provider_save_finish (IdeConfigurationProvider *self
,GAsyncResult *result
,GError **error
);
Completes an asynchronous request to ide_configuration_provider_save_async()
.
void ide_configuration_provider_delete (IdeConfigurationProvider *self
,IdeConfiguration *config
);
Requests that the configuration provider delete the configuration.
ide_configuration_provider_save_async() will be called by the IdeConfigurationManager after calling this function.
Since: 3.28
void ide_configuration_provider_duplicate (IdeConfigurationProvider *self
,IdeConfiguration *config
);
Requests that the configuration provider duplicate the configuration.
This is useful when the user wants to experiment with alternate settings without breaking a previous configuration.
The configuration provider does not need to persist the configuration
in this function, ide_configuration_provider_save_async()
will be called
afterwards to persist configurations to disk.
It is expected that the IdeConfigurationProvider will emit “added” with the new configuration.
Since: 3.28
void
ide_configuration_provider_unload (IdeConfigurationProvider *self
);
Requests that the configuration provider unload any state. This is called shortly before the configuration provider is finalized.
Implementations of IdeConfigurationProvider should emit removed for every configuration they have registered so that the IdeConfigurationManager has correct information.
#define IDE_TYPE_CONFIGURATION_PROVIDER (ide_configuration_provider_get_type ())
struct IdeConfigurationProviderInterface { GTypeInterface parent_iface; void (*added) (IdeConfigurationProvider *self, IdeConfiguration *config); void (*removed) (IdeConfigurationProvider *self, IdeConfiguration *config); void (*load_async) (IdeConfigurationProvider *self, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean (*load_finish) (IdeConfigurationProvider *self, GAsyncResult *result, GError **error); void (*save_async) (IdeConfigurationProvider *self, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean (*save_finish) (IdeConfigurationProvider *self, GAsyncResult *result, GError **error); void (*delete) (IdeConfigurationProvider *self, IdeConfiguration *config); void (*duplicate) (IdeConfigurationProvider *self, IdeConfiguration *config); void (*unload) (IdeConfigurationProvider *self); };
“added”
signalvoid user_function (IdeConfigurationProvider *ideconfigurationprovider, IdeConfiguration *arg1, gpointer user_data)
Flags: Run Last
“removed”
signalvoid user_function (IdeConfigurationProvider *ideconfigurationprovider, IdeConfiguration *arg1, gpointer user_data)
Flags: Run Last