1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
4 * Copyright (C) Naba Kumar <naba@gnome.org>
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 #ifndef _ANJUTA_SHELL_H
21 #define _ANJUTA_SHELL_H
23 #include <glib-object.h>
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>
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))
42 #define ANJUTA_SHELL_ERROR anjuta_shell_error_quark()
44 typedef struct _AnjutaShell AnjutaShell
;
45 typedef struct _AnjutaShellIface AnjutaShellIface
;
49 * @ANJUTA_SHELL_ERROR_DOESNT_EXIST:
53 ANJUTA_SHELL_ERROR_DOESNT_EXIST
,
58 ANJUTA_SHELL_PLACEMENT_NONE
= 0,
59 ANJUTA_SHELL_PLACEMENT_TOP
,
60 ANJUTA_SHELL_PLACEMENT_BOTTOM
,
61 ANJUTA_SHELL_PLACEMENT_RIGHT
,
62 ANJUTA_SHELL_PLACEMENT_LEFT
,
63 ANJUTA_SHELL_PLACEMENT_CENTER
,
64 ANJUTA_SHELL_PLACEMENT_FLOATING
65 } AnjutaShellPlacement
;
67 struct _AnjutaShellIface
{
68 GTypeInterface g_iface
;
71 void (*value_added
) (AnjutaShell
*shell
, char *name
, GValue
*value
);
72 void (*value_removed
) (AnjutaShell
*shell
, char *name
);
73 void (*save_session
) (AnjutaShell
*shell
, AnjutaSessionPhase phase
,
74 AnjutaSession
*session
);
75 void (*load_session
) (AnjutaShell
*shell
, AnjutaSessionPhase phase
,
76 AnjutaSession
*session
);
77 void (*save_prompt
) (AnjutaShell
*shell
, AnjutaSavePrompt
*save_prompt
);
78 void (*exiting
) (AnjutaShell
*shell
);
81 AnjutaStatus
* (*get_status
) (AnjutaShell
*shell
, GError
**err
);
82 AnjutaUI
* (*get_ui
) (AnjutaShell
*shell
, GError
**err
);
83 AnjutaPreferences
* (*get_preferences
) (AnjutaShell
*shell
, GError
**err
);
84 AnjutaPluginManager
* (*get_plugin_manager
) (AnjutaShell
*shell
,
86 AnjutaProfileManager
* (*get_profile_manager
) (AnjutaShell
*shell
,
89 void (*add_widget_full
) (AnjutaShell
*shell
,
94 AnjutaShellPlacement placement
,
97 void (*add_widget_custom
) (AnjutaShell
*shell
,
101 const char *stock_id
,
103 AnjutaShellPlacement placement
,
106 void (*remove_widget
) (AnjutaShell
*shell
,
109 void (*present_widget
) (AnjutaShell
*shell
,
113 void (*iconify_dockable_widget
) (AnjutaShell
*shell
,
116 void (*hide_dockable_widget
) (AnjutaShell
*shell
,
119 void (*show_dockable_widget
) (AnjutaShell
*shell
,
122 void (*maximize_widget
) (AnjutaShell
*shell
,
123 const char *widget_name
,
125 void (*unmaximize
) (AnjutaShell
*shell
,
127 void (*add_value
) (AnjutaShell
*shell
,
131 void (*get_value
) (AnjutaShell
*shell
,
135 void (*remove_value
) (AnjutaShell
*shell
,
138 void (*saving_push
) (AnjutaShell
* shell
);
139 void (*saving_pop
) (AnjutaShell
* shell
);
140 GObject
* (*get_object
) (AnjutaShell
*shell
,
141 const char *iface_name
,
145 GQuark
anjuta_shell_error_quark (void);
146 GType
anjuta_shell_get_type (void);
148 AnjutaStatus
* anjuta_shell_get_status (AnjutaShell
*shell
, GError
**error
);
150 AnjutaUI
* anjuta_shell_get_ui (AnjutaShell
*shell
, GError
**error
);
152 AnjutaPreferences
* anjuta_shell_get_preferences (AnjutaShell
*shell
,
155 AnjutaPluginManager
* anjuta_shell_get_plugin_manager (AnjutaShell
*shell
,
158 AnjutaProfileManager
* anjuta_shell_get_profile_manager (AnjutaShell
*shell
,
161 void anjuta_shell_freeze (AnjutaShell
*shell
, GError
**error
);
162 void anjuta_shell_thaw (AnjutaShell
*shell
, GError
**error
);
164 void anjuta_shell_add_widget (AnjutaShell
*shell
,
168 const char *stock_id
,
169 AnjutaShellPlacement placement
,
172 void anjuta_shell_add_widget_custom (AnjutaShell
*shell
,
176 const char *stock_id
,
178 AnjutaShellPlacement placement
,
181 void anjuta_shell_add_widget_full (AnjutaShell
*shell
,
185 const char *stock_id
,
186 AnjutaShellPlacement placement
,
190 void anjuta_shell_remove_widget (AnjutaShell
*shell
,
193 void anjuta_shell_present_widget (AnjutaShell
*shell
,
196 void anjuta_shell_iconify_dockable_widget (AnjutaShell
*shell
,
199 void anjuta_shell_hide_dockable_widget (AnjutaShell
*shell
,
202 void anjuta_shell_show_dockable_widget (AnjutaShell
*shell
,
205 void anjuta_shell_maximize_widget (AnjutaShell
*shell
,
206 const char *widget_name
,
208 void anjuta_shell_unmaximize (AnjutaShell
*shell
,
210 void anjuta_shell_add_value (AnjutaShell
*shell
,
214 void anjuta_shell_add_valist (AnjutaShell
*shell
,
215 const char *first_name
,
218 void anjuta_shell_add (AnjutaShell
*shell
,
219 const char *first_name
,
222 void anjuta_shell_get_value (AnjutaShell
*shell
,
226 void anjuta_shell_get_valist (AnjutaShell
*shell
,
227 const char *first_name
,
230 void anjuta_shell_get (AnjutaShell
*shell
,
231 const char *first_name
,
234 void anjuta_shell_remove_value (AnjutaShell
*shell
,
238 GObject
*anjuta_shell_get_object (AnjutaShell
*shell
,
239 const gchar
*iface_name
,
241 void anjuta_shell_session_save (AnjutaShell
*shell
,
242 const gchar
*session_directory
,
244 void anjuta_shell_session_load (AnjutaShell
*shell
,
245 const gchar
*session_directory
,
247 void anjuta_shell_save_prompt (AnjutaShell
*shell
,
248 AnjutaSavePrompt
*prompt
,
250 void anjuta_shell_notify_exit (AnjutaShell
*shell
, GError
**error
);
251 void anjuta_shell_saving_push (AnjutaShell
* shell
);
252 void anjuta_shell_saving_pop (AnjutaShell
* shell
);
256 * anjuta_shell_get_interface:
257 * @shell: A #AnjutaShell object
258 * @iface_type: The interface type implemented by the object to be found
259 * @error: Error propagation object.
261 * Equivalent to anjuta_shell_get_object(), but additionally typecasts returned
262 * object to the interface type. It also takes interface type directly. A
263 * usage of this function is:
265 * IAnjutaDocumentManager *docman =
266 * anjuta_shell_get_interface (shell, IAnjutaDocumentManager, error);
269 #define anjuta_shell_get_interface(shell, iface_type, error) \
270 ((iface_type*) anjuta_shell_get_object((shell), #iface_type, (error)))