libanjuta/anjuta-shell.h

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
   2 /*
   3  * anjuta-shell.h
   4  * Copyright (C) Naba Kumar  <naba@gnome.org>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20 #ifndef _ANJUTA_SHELL_H
  21 #define _ANJUTA_SHELL_H
  22
  23 #include <glib-object.h>
  24 #include <gtk/gtkwidget.h>
  25
  26 #include <libanjuta/anjuta-shell.h>
  27 #include <libanjuta/anjuta-status.h>
  28 #include <libanjuta/anjuta-ui.h>
  29 #include <libanjuta/anjuta-preferences.h>
  30 #include <libanjuta/anjuta-plugin-manager.h>
  31 #include <libanjuta/anjuta-profile-manager.h>
  32 #include <libanjuta/anjuta-session.h>
  33 #include <libanjuta/anjuta-save-prompt.h>
  34
  35 G_BEGIN_DECLS
  36
  37 #define ANJUTA_TYPE_SHELL            (anjuta_shell_get_type ())
  38 #define ANJUTA_SHELL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), ANJUTA_TYPE_SHELL, AnjutaShell))
  39 #define ANJUTA_IS_SHELL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ANJUTA_TYPE_SHELL))
  40 #define ANJUTA_SHELL_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ANJUTA_TYPE_SHELL, AnjutaShellIface))
  41
  42 #define ANJUTA_SHELL_ERROR anjuta_shell_error_quark()
  43
  44 typedef struct _AnjutaShell      AnjutaShell;
  45 typedef struct _AnjutaShellIface AnjutaShellIface;
  46
  47 typedef enum
  48 {
  49         ANJUTA_SHELL_ERROR_DOESNT_EXIST,
  50 } AnjutaShellError;
  51
  52 typedef enum
  53 {
  54         ANJUTA_SHELL_PLACEMENT_NONE = 0,
  55         ANJUTA_SHELL_PLACEMENT_TOP,
  56         ANJUTA_SHELL_PLACEMENT_BOTTOM,
  57         ANJUTA_SHELL_PLACEMENT_RIGHT,
  58         ANJUTA_SHELL_PLACEMENT_LEFT,
  59         ANJUTA_SHELL_PLACEMENT_CENTER,
  60         ANJUTA_SHELL_PLACEMENT_FLOATING
  61 } AnjutaShellPlacement;
  62
  63 struct _AnjutaShellIface {
  64         GTypeInterface g_iface;
  65
  66         /* Signals */
  67         void (*value_added)  (AnjutaShell *shell, char *name, GValue *value);
  68         void (*value_removed) (AnjutaShell *shell, char *name);
  69         void (*save_session) (AnjutaShell *shell, AnjutaSessionPhase phase,
  70                                                   AnjutaSession *session);
  71         void (*load_session) (AnjutaShell *shell, AnjutaSessionPhase phase,
  72                                                   AnjutaSession *session);
  73         void (*save_prompt)  (AnjutaShell *shell, AnjutaSavePrompt *save_prompt);
  74         void (*exiting)      (AnjutaShell *shell);
  75
  76         /* Virtual Table */
  77         AnjutaStatus* (*get_status) (AnjutaShell  *shell, GError **err);
  78         AnjutaUI* (*get_ui) (AnjutaShell  *shell, GError **err);
  79         AnjutaPreferences* (*get_preferences) (AnjutaShell *shell, GError **err);
  80         AnjutaPluginManager* (*get_plugin_manager) (AnjutaShell *shell,
  81                                                                                                 GError **err);
  82         AnjutaProfileManager* (*get_profile_manager) (AnjutaShell *shell,
  83                                                                                                   GError **err);
  84
  85         void (*add_widget)        (AnjutaShell  *shell,
  86                                                            GtkWidget    *widget,
  87                                                            const char   *name,
  88                                                            const char   *title,
  89                                                            const char   *stock_id,
  90                                                            AnjutaShellPlacement placement,
  91                                                            GError      **error);
  92         void (*remove_widget)     (AnjutaShell  *shell,
  93                                                            GtkWidget    *widget,
  94                                                            GError      **error);
  95         void (*present_widget)    (AnjutaShell  *shell,
  96                                                            GtkWidget    *widget,
  97                                                            GError      **error);
  98         void (*add_value)         (AnjutaShell  *shell,
  99                                                            const char   *name,
 100                                                            const GValue *value,
 101                                                            GError       **error);
 102         void (*get_value)         (AnjutaShell  *shell,
 103                                                            const char   *name,
 104                                                            GValue       *value,
 105                                                            GError       **error);
 106         void (*remove_value)      (AnjutaShell  *shell,
 107                                                            const char   *name,
 108                                                            GError       **error);
 109         GObject* (*get_object)    (AnjutaShell  *shell,
 110                                                            const char   *iface_name,
 111                                                            GError       **error);
 112 };
 113
 114 GQuark anjuta_shell_error_quark     (void);
 115 GType  anjuta_shell_get_type        (void);
 116
 117 AnjutaStatus* anjuta_shell_get_status (AnjutaShell *shell, GError **error);
 118
 119 AnjutaUI* anjuta_shell_get_ui (AnjutaShell *shell, GError **error);
 120
 121 AnjutaPreferences* anjuta_shell_get_preferences (AnjutaShell *shell,
 122                                                                                                  GError **error);
 123
 124 AnjutaPluginManager* anjuta_shell_get_plugin_manager (AnjutaShell *shell,
 125                                                                                                           GError **error);
 126
 127 AnjutaProfileManager* anjuta_shell_get_profile_manager (AnjutaShell *shell,
 128                                                                                                                 GError **error);
 129
 130 void anjuta_shell_freeze (AnjutaShell *shell, GError **error);
 131 void anjuta_shell_thaw (AnjutaShell *shell, GError **error);
 132
 133 void   anjuta_shell_add_widget      (AnjutaShell     *shell,
 134                                                                          GtkWidget       *widget,
 135                                                                          const char      *name,
 136                                                                          const char      *title,
 137                                                                          const char      *stock_id,
 138                                                                          AnjutaShellPlacement placement,
 139                                                                          GError         **error);
 140 void   anjuta_shell_remove_widget   (AnjutaShell     *shell,
 141                                                                          GtkWidget       *widget,
 142                                                                          GError         **error);
 143 void   anjuta_shell_present_widget  (AnjutaShell     *shell,
 144                                                                          GtkWidget       *widget,
 145                                                                          GError         **error);
 146 void   anjuta_shell_add_value       (AnjutaShell     *shell,
 147                                                                          const char      *name,
 148                                                                          const GValue    *value,
 149                                                                          GError         **error);
 150 void   anjuta_shell_add_valist      (AnjutaShell     *shell,
 151                                                                          const char      *first_name,
 152                                                                          GType            first_type,
 153                                                                          va_list          var_args);
 154 void   anjuta_shell_add             (AnjutaShell     *shell,
 155                                                                          const char      *first_name,
 156                                                                          GType            first_type,
 157                                                                          ...);
 158 void   anjuta_shell_get_value       (AnjutaShell     *shell,
 159                                                                          const char      *name,
 160                                                                          GValue          *value,
 161                                                                          GError         **error);
 162 void   anjuta_shell_get_valist      (AnjutaShell     *shell,
 163                                                                          const char      *first_name,
 164                                                                          GType            first_type,
 165                                                                          va_list          var_args);
 166 void   anjuta_shell_get             (AnjutaShell     *shell,
 167                                                                          const char      *first_name,
 168                                                                          GType            first_type,
 169                                                                          ...);
 170 void   anjuta_shell_remove_value    (AnjutaShell     *shell,
 171                                                                          const char      *name,
 172                                                                          GError         **error);
 173
 174 GObject *anjuta_shell_get_object    (AnjutaShell *shell,
 175                                                                          const gchar *iface_name,
 176                                                                          GError **error);
 177 void anjuta_shell_session_save      (AnjutaShell *shell,
 178                                                                          const gchar *session_directory,
 179                                                                          GError **error);
 180 void anjuta_shell_session_load      (AnjutaShell *shell,
 181                                                                          const gchar *session_directory,
 182                                                                          GError **error);
 183 void anjuta_shell_save_prompt       (AnjutaShell *shell,
 184                                                                          AnjutaSavePrompt *prompt,
 185                                                                          GError **error);
 186 void anjuta_shell_notify_exit       (AnjutaShell *shell, GError **error);
 187
 188 /**
 189  * anjuta_shell_get_interface:
 190  * @shell: A #AnjutaShell object
 191  * @iface_type: The interface type implemented by the object to be found
 192  * @error: Error propagation object.
 193  *
 194  * Equivalent to anjuta_shell_get_object(), but additionally typecasts returned
 195  * object to the interface type. It also takes interface type directly. A
 196  * usage of this function is:
 197  * <programlisting>
 198  * IAnjutaDocumentManager *docman =
 199  *     anjuta_shell_get_interface (shell, IAnjutaDocumentManager, error);
 200  * </programlisting>
 201  */
 202 #define anjuta_shell_get_interface(shell, iface_type, error) \
 203         ((iface_type*) anjuta_shell_get_object((shell), #iface_type, (error)))
 204
 205 G_END_DECLS
 206
 207 #endif