libanjuta/anjuta-command.h

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
   2 /*
   3  * anjuta
   4  * Copyright (C) James Liggett 2007 <jrliggett@cox.net>
   5  *
   6  * anjuta is free software.
   7  *
   8  * You may redistribute it and/or modify it under the terms of the
   9  * GNU General Public License, as published by the Free Software
  10  * Foundation; either version 2 of the License, or (at your option)
  11  * any later version.
  12  *
  13  * anjuta is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  16  * See the GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with anjuta.  If not, write to:
  20  *      The Free Software Foundation, Inc.,
  21  *      51 Franklin Street, Fifth Floor
  22  *      Boston, MA  02110-1301, USA.
  23  */
  24
  25 #ifndef _ANJUTA_COMMAND_H_
  26 #define _ANJUTA_COMMAND_H_
  27
  28 #include <glib-object.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define ANJUTA_TYPE_COMMAND             (anjuta_command_get_type ())
  33 #define ANJUTA_COMMAND(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), ANJUTA_TYPE_COMMAND, AnjutaCommand))
  34 #define ANJUTA_COMMAND_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), ANJUTA_TYPE_COMMAND, AnjutaCommandClass))
  35 #define ANJUTA_IS_COMMAND(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ANJUTA_TYPE_COMMAND))
  36 #define ANJUTA_IS_COMMAND_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), ANJUTA_TYPE_COMMAND))
  37 #define ANJUTA_COMMAND_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), ANJUTA_TYPE_COMMAND, AnjutaCommandClass))
  38
  39 typedef struct _AnjutaCommandClass AnjutaCommandClass;
  40 typedef struct _AnjutaCommand AnjutaCommand;
  41 typedef struct _AnjutaCommandPriv AnjutaCommandPriv;
  42
  43 struct _AnjutaCommandClass
  44 {
  45         GObjectClass parent_class;
  46
  47         /* Virtual Methods */
  48         guint (*run) (AnjutaCommand *self);
  49         void (*start) (AnjutaCommand *self);
  50         void (*cancel) (AnjutaCommand *self);
  51         void (*notify_data_arrived) (AnjutaCommand *self);
  52         void (*notify_complete) (AnjutaCommand *self, guint return_code);
  53         void (*notify_progress) (AnjutaCommand *self, gfloat progress);
  54         void (*set_error_message) (AnjutaCommand *self, const gchar *error_message);
  55         gchar * (*get_error_message) (AnjutaCommand *self);
  56         gboolean (*start_automatic_monitor) (AnjutaCommand *self);
  57         void (*stop_automatic_monitor) (AnjutaCommand *self);
  58
  59         /* Signals */
  60         void (*data_arrived) (AnjutaCommand *command);
  61         void (*command_started) (AnjutaCommand *command);
  62         void (*command_finished) (AnjutaCommand *command, guint return_code);
  63         void (*progress) (AnjutaCommand *command, gfloat progress);
  64
  65 };
  66
  67 struct _AnjutaCommand
  68 {
  69         GObject parent_instance;
  70
  71         AnjutaCommandPriv *priv;
  72 };
  73
  74 GType anjuta_command_get_type (void) G_GNUC_CONST;
  75
  76 void anjuta_command_start (AnjutaCommand *self);
  77 void anjuta_command_cancel (AnjutaCommand *self);
  78 void anjuta_command_notify_data_arrived (AnjutaCommand *self);
  79 void anjuta_command_notify_complete (AnjutaCommand *self, guint return_code);
  80 void anjuta_command_notify_progress (AnjutaCommand *self, gfloat progress);
  81 gboolean anjuta_command_is_running (AnjutaCommand *self);
  82
  83 void anjuta_command_set_error_message (AnjutaCommand *self, const gchar *error_message);
  84 gchar *anjuta_command_get_error_message (AnjutaCommand *self);
  85
  86 gboolean anjuta_command_start_automatic_monitor (AnjutaCommand *self);
  87 void anjuta_command_stop_automatic_monitor (AnjutaCommand *self);
  88
  89 G_END_DECLS
  90
  91 #endif /* _ANJUTA_COMMAND_H_ */