| Top |  |
 |
 |
 |
AnjutaCommandAnjutaCommand — System for creating objects that provide a standard interface to external components (libraries, processes, etc.) |
Functions
| void | anjuta_command_start () |
| void | anjuta_command_cancel () |
| void | anjuta_command_notify_data_arrived () |
| void | anjuta_command_notify_complete () |
| void | anjuta_command_notify_progress () |
| gboolean | anjuta_command_is_running () |
| void | anjuta_command_set_error_message () |
| gchar * | anjuta_command_get_error_message () |
| gboolean | anjuta_command_start_automatic_monitor () |
| void | anjuta_command_stop_automatic_monitor () |
Signals
| void | command-finished | Run First |
| void | command-started | Run First |
| void | data-arrived | Run Last |
| void | progress | Run First |
Description
AnjutaCommand is the base class for objects that are designed to provide a layer of abstraction between UI code and some other component, like a library or child process. AnjutaCommand provides a simple and consistent interface for plugins to interact with these components without needing to concern themselves with the exact details of how these components work.
To create command objects, plugins derive them from an AnjutaCommand subclass like AnjutaAsyncCommand, which runs commands in another thread or AnjutaSyncCommand, which runs commands synchronously.
These classes determine how ::run is called and how signals are emitted. ::run is responsible for actually doing the work of the command. It is the responsiblity of the command object that does a certain task to implement ::run to do its job. Everything else is normally implemented by its parent classes at this point
For an example of how to use AnjutaCommand, see the Subversion and Git plugins.
Functions
anjuta_command_start ()
void
anjuta_command_start (AnjutaCommand *self);
Starts a command. Client code can handle data from the command by connecting to the ::data-arrived signal.
AnjutaCommand subclasses should override this method to determine how they call ::run, which actually does the command's legwork.
anjuta_command_cancel ()
void
anjuta_command_cancel (AnjutaCommand *self);
Cancels a running command.
anjuta_command_notify_data_arrived ()
void
anjuta_command_notify_data_arrived (AnjutaCommand *self);
Used by base classes derived from AnjutaCommand to emit the ::data-arrived signal. This method should be used by both base command classes and non-base classes as appropriate.
anjuta_command_notify_complete ()
void anjuta_command_notify_complete (AnjutaCommand *self,guint return_code);
Used by base classes derived from AnjutaCommand to emit the ::command-finished signal. This method should not be used by client code or AnjutaCommand objects that are not base classes.
anjuta_command_notify_progress ()
void anjuta_command_notify_progress (AnjutaCommand *self,gfloat progress);
Emits the ::progress signal. Can be used by both base classes and commands as needed.
anjuta_command_set_error_message ()
void anjuta_command_set_error_message (AnjutaCommand *self,const gchar *error_message);
Command objects use this to set error messages when they encounter some kind of failure.
anjuta_command_get_error_message ()
gchar *
anjuta_command_get_error_message (AnjutaCommand *self);
Get the error message from the command, if there is one. This method is normally used from a ::command-finished handler to report errors to the user when a command finishes.
anjuta_command_start_automatic_monitor ()
gboolean
anjuta_command_start_automatic_monitor
(AnjutaCommand *self);
Sets up any monitoring needed for commands that should start themselves automatically in response to some event.
anjuta_command_stop_automatic_monitor ()
void
anjuta_command_stop_automatic_monitor (AnjutaCommand *self);
Stops automatic monitoring for self executing commands. For commands that do not support self-starting, this function does nothing.
Signal Details
The “command-finished” signal
void user_function (AnjutaCommand *command, guint return_code, gpointer user_data)
Flags: Run First
The “command-started” signal
void user_function (AnjutaCommand *anjutacommand, gpointer user_data)
Flags: Run First
The “data-arrived” signal
void user_function (AnjutaCommand *command, gpointer user_data)
Flags: Run Last
The “progress” signal
void user_function (AnjutaCommand *command, gfloat progress, gpointer user_data)
Flags: Run First